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 flag to toggle trained weights in tutorial. Also removed unused import. #164 #186

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

Conversation

chrissy0
Copy link

@chrissy0 chrissy0 commented Jun 2, 2023

Hey there,

I've tried implementing the changes requested in issue #164. Please let me know if this is how you imagined the implementation or if I should make any other changes.

Best,
Christopher

@chr5tphr
Copy link
Owner

Hey Christopher (cool name ;)),

thanks a lot for the PR and sorry for the delay!
My goal for issue #164 was to implement a mechanism to detect whether the documentation is currently being compiled on readthedocs.org, or in github actions/locally, in order to automatically use the trained weights in the documentation only when we're serious about it, since it will introduce a considerable delay/point of failure when only testing whether the notebook executes correctly.

If you would like to check out how to do this and then implement this in this PR, please go ahead!

You will probably have to add some changes in the ipynb-compilation pipeline in Sphinx. The automatic detection is probably done better by simply adding a command line option, which can then be provided only for RTD (and people who want the nice-looking heatmaps in their local documentation).

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