Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added notes on deprecation policy #288

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

mahjongmen
Copy link
Contributor

@mahjongmen mahjongmen commented Dec 9, 2024

This PR introduces a new section, 'Model Status', to the 'fern/pages/going-to-production/deprecations.mdx' file. This section provides a comprehensive overview of publicly released models, including their names, types, guaranteed availability, current status, deprecation, and shutdown information.

Changes:

  • A new section, 'Model Status', is added to the file, presenting a table with detailed information about publicly released models.
  • The table includes columns for 'Model Name', 'Type of Model', 'Guaranteed Available Until', 'Current Status', 'Deprecated', and 'Shutdown'.
  • The 'Model Name' column lists various models, such as 'command-r-plus-08-2024', 'command-r-08-2024', 'c4ai-aya-expanse-8b', and more.
  • The 'Type of Model' column categorizes models as 'Generative', 'Embeddings', or 'Rerankers'.
  • The 'Guaranteed Available Until' column specifies the date until which the models are guaranteed to be available.
  • The 'Current Status' column indicates the current status of the models, such as 'Active' or 'Legacy'.
  • The 'Deprecated' and 'Shutdown' columns provide information about the deprecation and shutdown status of the models, respectively.

@mahjongmen mahjongmen requested a review from a team as a code owner December 9, 2024 14:05
Copy link

github-actions bot commented Dec 9, 2024

@@ -9,7 +9,7 @@ keywords: 'Cohere API, large language models, generative AI'
createdAt: 'Wed Nov 27 2024 00:00:00 GMT+0000 (Coordinated Universal Time)'
updatedAt: 'Wed Nov 27 2024 00:00:00 GMT+0000 (Coordinated Universal Time)'
---
Find information around deprecated endpoints and models with their recommended replacements.
Find information around deprecated endpoints and models with their recommended replacements. All deprecation announcements applies to models being accessed through our API. It does not apply to models served/hosted/deployed outside our API, where ad-hoc deprecation policies apply.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason to differentiate Platform vs API. It can be maintenance heavy. Why not simple one rule for all access mediums and channels ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just my food for thought, but Sagemaker costs us almost nothing to maintain and we are bounded by different deprecation patterns for different platforms (Azure vs. AWS vs. Oracle). If that is the case, we have full control over platform which allows us to have a clear deprecation policy here?

LMK if that doesn't make sense - both anthropic and OAI list their deprecations are for their API only.

Anthropic

Screenshot 2024-12-17 at 9 49 55 AM

Open AI

Screenshot 2024-12-17 at 9 50 13 AM

Once a model is deprecated, it is imperative to migrate all usage to a suitable replacement before the shutdown date. Requests to models and endpoints past the shutdown date will fail.
To ensure a smooth transition, we recommend thorough testing of your applications with the new models well before the shutdown date. If your team requires assistance, do not hesitate to reach out to [email protected].

## Notifications
Cohere notifies customer with active usage of models for upcoming shutdown dates. We notify customers of upcoming shutdown dates as follows:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you mean warn users about the deprecated models?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep adjusted

Cohere notifies customer with active usage of models for upcoming shutdown dates. We notify customers of upcoming shutdown dates as follows:

1. At model launch, we designate a “Guaranteed Available Until” date (at least one year out)
2. We provide at least 6 months(1) notice before model retirement for publicly release models

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need (1) ? Isn't (2) sufficient so that based on usage we can take a call to whether to support or not.
See for example, Rerank Nimble and Rerank Express. They aren't on platform and we released for channels and we are forced to support it for 1yr even when there aren't much usages?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see noted and changed

## Model Status
All publicly released models are listed below with their status:

| Model Name | Type of Model | Guaranteed Available Until | Current Status | Deprecated | Shutdown |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this list can go stale very often. Is this going to be the Single place for all our public models and policies?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have this list: https://docs.cohere.com/docs/models but this list shows the models and where they are available.

I like the idea of having separate lists where this is just focused on deprecation. We do need to be on top of this list though as well as the other list

@@ -9,7 +9,7 @@ keywords: 'Cohere API, large language models, generative AI'
createdAt: 'Wed Nov 27 2024 00:00:00 GMT+0000 (Coordinated Universal Time)'
updatedAt: 'Wed Nov 27 2024 00:00:00 GMT+0000 (Coordinated Universal Time)'
---
Find information around deprecated endpoints and models with their recommended replacements.
Find information around deprecated endpoints and models with their recommended replacements. All deprecation announcements applies to models being accessed through our API. It does not apply to models served/hosted/deployed outside our API, where ad-hoc deprecation policies apply.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should say "ad-hoc deprecation policies apply".

Instead say something like, "Please refer to partner documentation for deprecation policy on specific partner platforms."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adjusted

Copy link

@co-sudip co-sudip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to either limit this to "Model Deprecations" or add some more content to specific "Product Deprecations" beyond the model itself -- including things like chat.cohere.com or endpoints like generate/summarize or finetuning.

@@ -21,10 +21,46 @@ Cohere uses the following terms to describe the lifecycle of our models:
- **Deprecated:** The model and endpoints are no longer available to new customers but remain available to existing users until retirement. (An existing user is defined as anyone who has used the model or endpoint within 90 days of the deprecation announcement.) A shutdown date will be assigned at that time.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the existing user only caveat, but I am not sure if we have that ability today. Do we @manoj-cohere ?

| `embed-english-light-v2.0` | Embeddings | N/A | Legacy | N/A | N/A |
| `embed-multilingual-v2.0` | Embeddings | N/A | Legacy | N/A | N/A |
| `rerank-v3.5` | Rerankers | 12/31/2025 | Active | N/A | N/A |
| `rerank-english-v3.0 | Rerankers | 06/30/2025 | Active | N/A | N/A |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think new users can continue to be onboarded to rerank v2.0 on Platform today.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes I believe so

| `embed-english-v3.0` | Embeddings | 06/30/2025 | Active | N/A | N/A |
| `embed-english-light-v3.0` | Embeddings | 06/30/2025 | Active | N/A | N/A |
| `embed-multilingual-v3.0` | Embeddings | 06/30/2025 | Active | N/A | N/A |
| `embed-multilingual-light-v3.0` | Embeddings | N/A | Legacy | N/A | N/A |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why N/A for these?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I put N/A because we don't have a specified date for deprecation currently right?

Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants