TensorFlow Addons welcomes and highly encourages tutorial contributions.
Addons tutorials are created using Google Colab and the jupyter notebooks are saved to this directory in the repository. To do this, follow the below steps:
- Create a new branch on your fork of TensorFlow Addons
- Goto Google Colab and start a new notebook using addons example template: docs/tutorials/_template.ipynb
- Edit the links for the "View source on GitHub" and "Run in Google Colab" URL boxes so that they match the name of your new example notebook
- Follow the guidelines of the template
- "Save a copy in GitHub" and select your new branch. The notebook should be
named
subpackage_submodule
- Submit the branch as a PR on the TF-Addons GitHub