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

Visualization Documentation #1

Open
nreinicke opened this issue Oct 23, 2023 · 0 comments
Open

Visualization Documentation #1

nreinicke opened this issue Oct 23, 2023 · 0 comments

Comments

@nreinicke
Copy link
Collaborator

nreinicke commented Oct 23, 2023

We should create some documentation for how to use the visualization functions/script (Something like the batch-trainer README.md). It should detail the following:

  • How to setup the visualization config file for running the visualization script (detail what each parameter is, which ones are required, show some examples of a config file)
  • How to use the visualization function in a notebook or script. There is already some documentation for the function in docstrings, but perhaps we could add an example of how to use it in a notebook
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant