mlcommons / GaNDLF

A generalizable application framework for segmentation, regression, and classification using PyTorch
https://gandlf.org
Apache License 2.0
150 stars 78 forks source link

[FEATURE] Add a "migration guide" in documentation #843

Open sarthakpati opened 3 months ago

sarthakpati commented 3 months ago
          I vote to move to `0.1.0` after this PR gets merged rather than `0.0.20`, since it is going to be a pretty big API change.

Originally posted by @sarthakpati in https://github.com/mlcommons/GaNDLF/issues/818#issuecomment-2034761169

There needs to be migration guide in the documentation for folks moving from 0.0.XX to 0.1.0. This should include at least 2 items:

  1. Details about how to use the new configuration structure (after #841).
  2. Details about using the new CLI API.
github-actions[bot] commented 1 month ago

Stale issue message