- Requirements
- How to update the notebooks?
- Jupyter and Google Colab
- Kaggle kernels
- Screenshots
- Developer guide
- Contributing
The below are required in order to be able to amend the notebooks and update the repo:
- jupyter (notebook or labs)
nbdime
plugin for jupyter (notebook or labs): helps with comparing and viewinggit
related changes- install
pre-commit
in the root of the project folder:pip install pre-commit
- enable
pre-commit
in the root of the project folder:pre-commit install
You can also run pre-commit
manually by doing the below:
pre-commit run --all
(This is automatically run in the CI/CD when commits are pushed and/or pull request is created on the repo).
In order to change the notebooks:
- First run
jupyter
by doing the following:
$ jupyter labs .
or
$ jupyter notebook .
- Regenerate the relevant notebook(s) by running all the cells.
- Fix any error, issues in it/them
- Run the formatting as mentioned in the Developer guide: Notebooks
- Once you are happy, then commit your changes.
- Push commits to remote branch
- Create pull request
Open Notebook in Jupyter on your local machine or you can open these notebooks directly in Google Colab by clicking on the button.
All the notebooks in this folder are dual notebooks - you should be able to use them in both Google Colab and in Jupyter.
Notebook/Kernel | Script | Other related links
See Developer guide to know how to build, test, and contribute to the library.
Contributions are Welcome!
Please have a look at the CONTRIBUTING guidelines.
Please share it with the wider community (and get credited for it)!
Go to the Main page