Skip to content

Conversation

andreped
Copy link
Collaborator

@andreped andreped commented Jun 2, 2023

Made the initial draft of the Documentations, which are stored in docs/.

The goal is to serve this at readthedocs.org, and offer more detailed examples, use cases, and API documentation on existing methods.

Not completely finished yet, but I am open to feedback on the current solution (hence, draft).

TODO:

  • Setup Docs using Sphinx with autodocs
  • Add examples for all normalization techniques
  • Add PyTorch and TensorFlow Dataset generation for training examples
  • Link and serve this repo to Read The Docs

@andreped andreped mentioned this pull request Jun 2, 2023
@andreped
Copy link
Collaborator Author

andreped commented Jun 2, 2023

Might be that we should bundle example for individual methods we wish to make accessible by the end user directly from the code documentations, like Keras and scikit-learn do.

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

Successfully merging this pull request may close these issues.

1 participant