Skip to content

Docs: Roadmap for update #47

@jdeschamps

Description

@jdeschamps

Here is a list of things to be fixed or add for the next update. There won't be time to turn them into sub-issues, so we will keep them as lists for now, but we should create issues if these are not taken care within a reasonable time frame.

  • Fix CAREamics-example CI
  • Add NG Dataset docs
  • Add tutorials for WandB and TensorBoard
  • Add uv installation instructions
  • Add PEP723 headers to applications
  • Remove roadmap section or change text for something more in line with the current thoughts
  • Restructure CAREamist API
  • Update docs to fix errors in examples
  • Rethink examples -> only a few hand selected examples
  • Remove portfolio from sources
  • Fix examples
  • Fix notebooks
  • Add lock files to examples
  • Update napari docs
  • Add CLI docs
  • Docs about NG Dataset + tutorials
  • List potential tutorials
  • Remove history to allow for a lighter repo, + enforce commits squash
  • Add documentation for looking at loss
  • Change python shield (>py3.11)
  • Automate CAREamics tag version with example snippet
  • Automated notebook update for careamics dependency
  • Document number of steps
  • Check recent PRs for new doc
  • Gather notebooks directly in application page
  • FAQ should be easier to find

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    In progress

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions