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

Improve documentation #367

Open
romeokienzler opened this issue Jan 14, 2025 · 5 comments
Open

Improve documentation #367

romeokienzler opened this issue Jan 14, 2025 · 5 comments
Assignees
Labels

Comments

@romeokienzler
Copy link
Collaborator

romeokienzler commented Jan 14, 2025

  • Improve current documentation (test if it is consistent, improve)
  • Add: dual LR
  • more tbd.
@biancazadrozny
Copy link
Collaborator

After going through the current documentation, here are the main things to be changed:

Tasks

Move multi-temporal Inputs to “Quickstart”
Improve initial description
Links to ModelFactory
Explanation about ModelABC
Improve description of each Task

Models

Include Backbones
(Decoders, Heads, Auxiliary Heads, Backbones)

Model Factories

Include “High level” Component - Model Factory, with a generic explanation and list of existing Model Factories

Data

Integrate examples from Prithvi 2.0
Add Pedro's datasets, with links to the repositories of Prithvi v 2.0

Registries

Example of how to create a custom module

Examples

Place in a separate section, at the component level
Add Notebooks from Prithvi 2.0

For Developers -> Overview Place within Components

@romeokienzler
Copy link
Collaborator Author

romeokienzler commented Feb 6, 2025

Bianca's Idea: make mkdocs to automatically create the list of available models -> https://github.com/IBM/terratorch/blob/main/mkdocs.yml

@biancazadrozny
Copy link
Collaborator

Tasks

  • Move multi-temporal Inputs to “Quickstart”
  • Improve initial description
  • Links to ModelFactory
  • Explanation about ModelABC
  • Improve description of each Task

Models

  • Include Backbones (Decoders, Heads, Auxiliary Heads, Backbones)

Model Factories

  • Include “High level” Component - Model Factory, with a generic explanation and list of existing Model Factories

Data

  • Integrate examples from Prithvi 2.0
  • Add Pedro's datasets, with links to the repositories of Prithvi v 2.0

Registries

  • Example of how to create a custom module

Examples

  • Place in a separate section, at the component level

  • Add Notebooks from Prithvi 2.0

  • For Developers -> Overview Place within Components

@biancazadrozny
Copy link
Collaborator

@PedroConrado can you check the https://ibm.github.io/terratorch/data/ documentation and add an example for a multi-temporal dataset (one that you created for Prithvi v 2.0).

@PedroConrado
Copy link
Collaborator

@PedroConrado can you check the https://ibm.github.io/terratorch/data/ documentation and add an example for a multi-temporal dataset (one that you created for Prithvi v 2.0).

#437 improves data documentation.

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

No branches or pull requests

3 participants