Update CONTRIBUTING_DOCS.md #2190
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added some Troubleshooting comments and some more details around the generation of notebook mds.
|
CLA Assistant Lite bot: I have read the CLA Document and I hereby sign the CLA You can retrigger this bot by commenting recheck in this Pull Request |
|
Preview this PR with FeatureBee: https://beta.wandb.ai/?betaVersion=f1c5f9299e6002070daa3832dd3e12dcae749f45 |
NiWaRe
commented
Aug 22, 2024
| @@ -116,11 +116,10 @@ To improve docs, basically follow FastAPI's instructions to create good Swagger | |||
|
|
|||
| ### Notebook Doc Gen | |||
|
|
|||
| Run `python scripts/generate_notebook.py` inside of `docs/` to automatically create a markdown version of the notebook. Add all new files to the commit. | |||
| From within the `docs` directory, run `python ./scripts/generate_notebook.py`. | |||
There was a problem hiding this comment.
@scottire the file should be generate_notebooks.py (with an 's')
| notebook_exporter.preprocessors = [ClearOutputPreprocessor()] | ||
| notebook_content, _ = notebook_exporter.from_filename(notebook_path) | ||
| markdown_exporter = MarkdownExporter() | ||
| output, _ = markdown_exporter.from_notebook_node(notebook_content) |
There was a problem hiding this comment.
@scottire there seems to be some error in the notebook_content you're passing to markdown_exporter.from_notebook_node(notebook_content). This is the error I'm getting when I run it:
Traceback (most recent call last):
File "/Users/niware_wb/Documents/wandb_internal/smle/demos/llms/weave/weave_source/docs/./scripts/generate_notebooks.py", line 67, in <module>
main()
File "/Users/niware_wb/Documents/wandb_internal/smle/demos/llms/weave/weave_source/docs/./scripts/generate_notebooks.py", line 60, in main
export_all_notebooks_in_primary_dir()
File "/Users/niware_wb/Documents/wandb_internal/smle/demos/llms/weave/weave_source/docs/./scripts/generate_notebooks.py", line 53, in export_all_notebooks_in_primary_dir
export_notebook(
File "/Users/niware_wb/Documents/wandb_internal/smle/demos/llms/weave/weave_source/docs/./scripts/generate_notebooks.py", line 31, in export_notebook
output, _ = markdown_exporter.from_notebook_node(notebook_content)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/niware_wb/Documents/wandb_internal/smle/demos/llms/weave/weave_source/venv/lib/python3.11/site-packages/nbconvert/exporters/templateexporter.py", line 408, in from_notebook_node
nb_copy, resources = super().from_notebook_node(nb, resources, **kw)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/niware_wb/Documents/wandb_internal/smle/demos/llms/weave/weave_source/venv/lib/python3.11/site-packages/nbconvert/exporters/exporter.py", line 150, in from_notebook_node
if "language" in nb["metadata"]:
~~^^^^^^^^^^^^
TypeError: string indices must be integers, not 'str'
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added some Troubleshooting comments and some more details around the generation of notebook mds.