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

JOSS review: End-to-end examples #48

Open
WarmCyan opened this issue Dec 2, 2024 · 1 comment
Open

JOSS review: End-to-end examples #48

WarmCyan opened this issue Dec 2, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@WarmCyan
Copy link
Collaborator

WarmCyan commented Dec 2, 2024

The examples and documentation don't make it clear how to start using the tool once it's up and running.

Make one or two example notebooks demonstrating start to finish applications, at least one should include applying the model afterwards to a new dataset

(Also update the docs to provide more suggestions/info on next steps/what to actually do. Possibly a new page after Interface)

@WarmCyan WarmCyan added the documentation Improvements or additions to documentation label Dec 2, 2024
@WarmCyan
Copy link
Collaborator Author

WarmCyan commented Jan 2, 2025

A notebook demonstrating a full walk through (including applying the trained model to a new dataset) is now here: https://github.com/ORNL/icat/blob/main/notebooks/usage_walkthrough.ipynb

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