diff --git a/docs/core_concepts/model_tiers.md b/docs/core_concepts/model_tiers.md index 73a30149..4d0448a8 100644 --- a/docs/core_concepts/model_tiers.md +++ b/docs/core_concepts/model_tiers.md @@ -60,7 +60,7 @@ guide. ```{note} **Version pinning.** For stable-only projects, pin a compatible range such as `deeptab>=2.0,<3.0`. For projects that use experimental models, pin the exact -version (`deeptab==2.0.0`), since their APIs may change between releases. +version (`deeptab==2.1.0`), since their APIs may change between releases. ``` ## Next Steps diff --git a/docs/getting_started/migration.md b/docs/getting_started/migration.md index 42d3fd8f..d8ccf7eb 100644 --- a/docs/getting_started/migration.md +++ b/docs/getting_started/migration.md @@ -260,7 +260,7 @@ from deeptab.models.experimental import ModernNCAClassifier, TangosRegressor, Tr ```{warning} Experimental models may change in minor releases. Pin an exact version such as -`deeptab==2.0.0` if you depend on one in production. +`deeptab==2.1.0` if you depend on one in production. ``` ## What did not change diff --git a/docs/model_zoo/comparison_tables.md b/docs/model_zoo/comparison_tables.md index ffa5d280..ae7ce024 100644 --- a/docs/model_zoo/comparison_tables.md +++ b/docs/model_zoo/comparison_tables.md @@ -127,7 +127,7 @@ The table below gives practical guidance on whether each model trains comfortabl The "CPU comfort zone" is where training at default config finishes in reasonable wall-clock time on a modern CPU. Beyond it, a CUDA, MPS, or similar accelerator provides meaningful speedup. ```{tip} -**Apple Silicon (MPS):** All models run on MPS via PyTorch's MPS backend. Set `accelerator="mps"` in `TrainerConfig`. MPS provides meaningful speedup for most models except those with Mamba CUDA kernels, which fall back to CPU on MPS unless a dedicated MPS implementation is available. +**Apple Silicon (MPS):** All models run on MPS via PyTorch's MPS backend. Pass `accelerator="mps"` to `fit()`. MPS provides meaningful speedup for most models except those with Mamba CUDA kernels, which fall back to CPU on MPS unless a dedicated MPS implementation is available. ``` ```{note} diff --git a/docs/tutorials/experimental.md b/docs/tutorials/experimental.md index dc747b96..793e9e3c 100644 --- a/docs/tutorials/experimental.md +++ b/docs/tutorials/experimental.md @@ -33,7 +33,7 @@ DeepTab sorts every model into one of two tiers. The tier is a contract about AP | ------------------- | -------------------------------------------------- | ------------------------------------------------------- | | **Import path** | `deeptab.models.experimental` | `deeptab.models` | | **API stability** | May change without a deprecation cycle | Frozen under semantic versioning | -| **Recommended pin** | Exact version (`deeptab==2.0.0`) | Range (`deeptab>=2.0,<3.0`) | +| **Recommended pin** | Exact version (`deeptab==2.1.0`) | Range (`deeptab>=2.0,<3.0`) | | **Best for** | Evaluating recent architectures, research feedback | Production, long-running baselines, reproducible suites | Before an experimental model graduates to the stable zoo it has to clear a documented bar: a conventional public API, a model-zoo page with a limitations section, a runnable end-to-end example, working `save`/`load` with a prediction round-trip test, passing behavioural tests in CI, no open correctness bugs, and registration in the model registry. Until then, treat its defaults as provisional. diff --git a/docs/tutorials/notebooks/experimental.ipynb b/docs/tutorials/notebooks/experimental.ipynb index a36c5c04..2863146d 100644 --- a/docs/tutorials/notebooks/experimental.ipynb +++ b/docs/tutorials/notebooks/experimental.ipynb @@ -58,13 +58,13 @@ "| --- | --- | --- |\n", "| **Import path** | `deeptab.models.experimental` | `deeptab.models` |\n", "| **API stability** | May change without a deprecation cycle | Frozen under semantic versioning |\n", - "| **Recommended pin** | Exact version (`deeptab==1.8.0`) | Range (`deeptab>=1.8,<2.0`) |\n", + "| **Recommended pin** | Exact version (`deeptab==2.1.0`) | Range (`deeptab>=2.0,<3.0`) |\n", "| **Best for** | Evaluating recent architectures, research feedback | Production, long-running baselines, reproducible suites |\n", "\n", "Before an experimental model graduates to the stable zoo it has to clear a documented bar: a conventional public API, a model-zoo page with a limitations section, a runnable end-to-end example, working `save`/`load` with a prediction round-trip test, passing behavioural tests in CI, no open correctness bugs, and registration in the model registry. Until then, treat its defaults as provisional.\n", "\n", "```{warning}\n", - "Pin the **exact** DeepTab version whenever experimental results go into a paper, a benchmark table, or anything you might need to reproduce later. A range such as `deeptab>=1.8` can silently pull a release that changes an experimental model's behaviour.\n", + "Pin the **exact** DeepTab version whenever experimental results go into a paper, a benchmark table, or anything you might need to reproduce later. A range such as `deeptab>=2.0` can silently pull a release that changes an experimental model's behaviour.\n", "```" ] },