Skip to content

Commit f8e2c31

Browse files
committed
Update READMEs
1 parent 27ea771 commit f8e2c31

File tree

2 files changed

+11
-18
lines changed

2 files changed

+11
-18
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ TF-Addons. In order to achieve these we require that our additions
4747
conform to established API patterns seen in core TensorFlow.
4848

4949
#### Proxy Maintainership
50-
Addons has been designed to compartmentatlizae subpackages and submodules so
50+
Addons has been designed to compartmentalize subpackages and submodules so
5151
that they can be maintained by users who have expertise and a vested interest
5252
in that component.
5353

examples/README.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,15 @@ TensorFlow Addons welcomes and highly encourages example contributions.
77

88
Addons examples are created using [Google Colab](https://colab.research.google.com/)
99
and the jupyter notebooks are saved to this directory in the repository. To do
10-
this... follow the below steps:
10+
this, follow the below steps:
1111

12-
1. Create a docs branch on your fork of TensorFlow Addons
12+
1. Create a new branch on your fork of TensorFlow Addons
1313
2. Goto [Google Colab](https://colab.research.google.com/) and start a new
14-
notebook using this template:
15-
[https://github.com/tensorflow/docs/blob/master/tools/templates/notebook.ipynb](https://github.com/tensorflow/docs/blob/master/tools/templates/notebook.ipynb)
16-
3. Remove the URL box titled "View on TensorFlow.org"
17-
8. Edit the "View source on Github" and "Run in Google Colab" URL boxesso that
18-
they point to the where the example notebook will exist on the master branch
19-
after the PR is merged.
20-
4. Install the correct TF versions at the top of the colab session:
21-
```
22-
!pip install tensorflow==2.0.0.a0
23-
!pip install tensorflow-addons
24-
```
25-
5. Follow the guidelines of the template
26-
6. "Save a copy in Github" and select your new branch. The notebook should be
27-
named `subpackage_submodule`
28-
7. Submit the branch as a PR on the TF-Addons Github
14+
notebook using addons example template:
15+
[examples/template.ipynb](examples/template.ipynb)
16+
3. Edit the the links for the "View source on GitHub" and "Run in Google Colab"
17+
URL boxes so that they match the name of your new example notebook.
18+
4. Follow the guidelines of the template
19+
5. "Save a copy in Github" and select your new branch. The notebook should be
20+
named `subpackage_submodule`.
21+
6. Submit the branch as a PR on the TF-Addons Github

0 commit comments

Comments
 (0)