📄 Add an upgrade guide for 0.1.x → v1.0.0 migration#439
Merged
Conversation
Add docs/source/upgrade_guide.md documenting the breaking changes introduced by the v1 prototype (PR #409): removed top-level Dataset re-export, plaid.types alias changes, removed modules (pipelines, post, several utils, examples), the simplified ProblemDefinition API, and the CGNS backend constant/variable removal. Also lists new modules (plaid.infos, plaid.viewer) and intermediate 0.1.x breaking changes. Wire the page into the zensical nav and add a CHANGELOG entry. Closes #406
Contributor
Author
|
You can see the result here : https://plaid-lib.readthedocs.io/en/docs-406-upgrade-guide/upgrade_guide.html |
xroynard
added
documentation
…d doc cross-links
Member
|
casenave
requested changes
Jun 5, 2026
|
|
||
| PLAID follows [Semantic Versioning](https://semver.org/). The `v1.0.0` release is | ||
| the first major release: it consolidates the data model, removes deprecated and | ||
| out-of-scope modules, and simplifies several public APIs. As a major release, it |
Member
There was a problem hiding this comment.
minor releases were also breaking API
| If you imported any of these, remove the import and move the corresponding logic | ||
| into your own project, or rely on the supported data-model APIs. | ||
|
|
||
| ### `ProblemDefinition` |
| level as `ProblemDefinition` (see [Infos](concepts/infos.md)). | ||
| - **`plaid.viewer`** — an interactive [trame](https://kitware.github.io/trame/) | ||
| application for visual dataset exploration (see [Viewer](concepts/viewer.md)). | ||
|
|
| `features=[...]` and `indexers={...}` for partial reads on the `hf_datasets` and | ||
| `zarr` backends — see the [Conversion tutorial](tutorials/storage.md#indexed-extraction-with-indexers). | ||
|
|
||
| ### `plaid.types` |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds an upgrade guide documenting how to migrate an existing code base from the
0.1.xseries to v1.0.0, inspired by the structure of the Hydra upgrade guides (one section per version jump, change-by-change, with before/after examples).The guide is built from the actual breaking changes introduced by the v1 prototype (#409) and the
CHANGELOG.md:Datasetis no longer re-exported fromplaid(import fromplaid.containers.dataset); newInfosexport;__version__moved fromplaid._versiontoplaid.version.plaid.types: removed (Scalar,Field,TimeSequence,Feature,SklearnBlock,FeatureIdentifier,ArrayDType,IndexType) and added (ScalarDType,IndexArrayType,ScalarOrArray,ScalarOrArrayOrStr).pipelines,post, severalutilsmodules,examples.ProblemDefinition:add_in/out_features_identifiers(and the set/get/constant variants) replaced byadd_input_features/add_output_features; surface reduced to a compact pydantic model.plaid.infos,plaid.viewer.0.1.xrelease.The page is wired into the zensical navigation (Overview > Upgrade guide) and a
CHANGELOG.mdentry was added.Closes #406
Checklist