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

Updating README with training and inference examples #6

Open
10 tasks
ramanakumars opened this issue Aug 22, 2023 · 0 comments
Open
10 tasks

Updating README with training and inference examples #6

ramanakumars opened this issue Aug 22, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ramanakumars
Copy link
Owner

ramanakumars commented Aug 22, 2023

Need to update README with more training and inference examples.

  • Add training information
    • List of required and optional keys
    • Documentation on model architecture
    • Example YAML file for training + documentation on downloading test set
    • Creating a Dataset class
  • Adding inference information
    • List of required and optional keys
    • Example YAML file for inference
    • Creating an inference Dataset class
    • Adding a save_mask method
@ramanakumars ramanakumars added the documentation Improvements or additions to documentation label Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant