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

Doc Update #17

Merged
merged 9 commits into from
Feb 29, 2024
Merged

Doc Update #17

merged 9 commits into from
Feb 29, 2024

Conversation

djgagne
Copy link
Collaborator

@djgagne djgagne commented Feb 28, 2024

Added jupyter notebooks to docs and install instructions.

.. code-block:: bash
pip install --upgrade keras


Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

recommend adding a 'tutorial' page walking through the notebooks, their purposes, and linking to the notebooks in Sphinx' index

@@ -0,0 +1 @@
../../../notebooks/classifier_example.ipynb
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will you all eventually add the other notebooks w/documentation in Sphinx?

docs/source/install.rst Show resolved Hide resolved




Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good place to leave troubleshooting notes for users getting started, if any arise. I've also seen packages incorporate an FAQ page into their documentation

@djgagne djgagne merged commit 76441e7 into main Feb 29, 2024
4 checks passed
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.

2 participants