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

Added Documentations #48

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

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.

None yet

1 participant