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

Add demo notebook #180

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

wbenoit26
Copy link
Contributor

This adds a demo notebook with instructions/examples for using some of the tools in ml4gw

@EthanMarx
Copy link
Collaborator

This is great. What are your thoughts on using the tutorials as a starting point for building out the docs? ( we should also migrate to using readthedocs like our other projects)

@wbenoit26
Copy link
Contributor Author

I see the tutorials as complementary to documentation more than as a place to build from. I think this notebook is a useful place for people to get started on understanding how to use various modules and what the advantages are, but it doesn't really give much detail about the specifics, and I wouldn't want it to. What I think would be good is to create a readthedocs page, and then link to the relevant pages throughout the notebook.

@EthanMarx
Copy link
Collaborator

All for keeping the notebook around in notebook form, especially for the end to end training example. This might just be a personal thing, but I'm much more likely to poke around a documentation page with code examples then to download a notebook and run it.

@wbenoit26
Copy link
Contributor Author

Oh I see, I hadn't thought about that option. Yeah, totally, when we build the documentation we should take some snippets from here (and if we put code in the documentation, we should consider adding it into the notebook as well, though I think that matters less).

@wbenoit26 wbenoit26 force-pushed the add-tutorial-notebook branch from efdc7bd to ce0438b Compare January 9, 2025 14:52
@EthanMarx
Copy link
Collaborator

Sounds good. Also need to update the pretty outdated README...

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