@@ -110,7 +110,7 @@ To do this, there are a few requirements that all notebooks need to pass.
110
110
` function(a=1, b=2) ` instead of ` function(1, 2) `
111
111
5 . Use ` from pathlib import Path ` for path manipulation instead of ` os.path `
112
112
6 . Add type hints to functions: https://www.python.org/dev/peps/pep-0484/
113
- 7 . Add ReST style docstrings (see[ 110 ] ( https://docs.openvino.ai/latest/ notebooks/210-ct-scan-live-inference-with-output.html )
113
+ 7 . Add ReST style docstrings (see [ 403 ] ( https://github.com/openvinotoolkit/openvino_notebooks/blob/main/ notebooks/403-action-recognition-webcam/403-action-recognition-webcam.ipynb )
114
114
for an example). It is not necessary to specify the parameter type in the docstring, since
115
115
type hints are already added to the function definition.
116
116
8 . Do not use global variables in functions: a function should not depend on values that are
@@ -275,7 +275,7 @@ standard `diff` tool for `git`, with much more useful output than the regular `g
275
275
276
276
#### JupyterLab Code Formatter
277
277
278
- [ JupyterLab Code Formatter] ( https://jupyterlab-code-formatter.readthedocs .io/en/latest/ ) adds a
278
+ [ JupyterLab Code Formatter] ( https://ryantam626.github .io/jupyterlab_code_formatter/index.html ) adds a
279
279
button to Jupyter Lab to automatically format the code in notebooks with black and isort. Please
280
280
use either this extension or a different way to automatically format your notebook.
281
281
@@ -288,12 +288,12 @@ use either this extension or a different way to automatically format your notebo
288
288
mentioned in the [ Validation] ( #Validation ) section.
289
289
3 . Create a branch in this fork, from the * main* branch. Name the
290
290
branch however you like.
291
- 4 . Doublecheck the points in the [ Design] ( #Design ) and [ Validation] ( #Validation ) sections.
291
+ 4 . Doublecheck the points in the [ Design Decisions ] ( #design-decisions ) and [ Validation] ( #Validation ) sections.
292
292
5 . Check that your notebook works in the CI
293
293
- Go to the GitHub page of your fork, click on _ Actions_ , select _ nbval_ on the left. There will
294
294
be a message _ This workflow has a workflow_dispatch event trigger._ and a _ Run workflow_ button.
295
295
Click on the button and select the branch that you want to test.
296
- 6 . Test if the notebook works in [ https://mybinder.org/ ] ( Binder ) and if so, add _ Launch Binder_ badges
296
+ 6 . Test if the notebook works in [ Binder ] ( https://mybinder.org/ ) and if so, add _ Launch Binder_ badges
297
297
to the README files.
298
298
299
299
Once your notebook passes in the CI and you have verified that everything looks good, make a Pull Request!
0 commit comments