|
1 | 1 |
|
2 | 2 | # :framed_picture: [SIG Logo](https://github.com/tensorflow/community/tree/master/sigs/logos) |
3 | 3 |
|
4 | | -## SIG presentation |
5 | | -A general short description of the Repository/SIG. |
| 4 | +## SIG description |
| 5 | +A short overview of the SIG goals & scope. |
6 | 6 |
|
7 | 7 | ## Example |
8 | | -A very minimal inline primer just to quiclky expose the library |
| 8 | +A minimal inline primer to quickly expose the library |
9 | 9 |
|
10 | | -## DOCS/API |
11 | | -Link to the Tensorflow web site |
| 10 | +## Docs/API |
| 11 | +Link to the appropriate Tensorflow web site page (if applicable) |
12 | 12 |
|
13 | | -## Badges section |
14 | | -Add badges for you repostiroy (pypy, python, gitter, api etc.) |
15 | | -CI/Buid specifc badges |
| 13 | +## Badges |
| 14 | +Add badges for you repository (pypy, python, gitter, api etc.) |
| 15 | +CI/Buid specific badges |
16 | 16 |
|
17 | | -## Tensorflow compatibility Matrix |
18 | | -Repository releases compatibility with TF and Python version or (other languages, cuda, etc.) |
| 17 | +## TensorFlow compatibility Matrix |
| 18 | +Releases compatibility with TF and Python versions or (other languages, cuda, etc.) |
19 | 19 |
|
20 | 20 | ## Project/Repository structure |
21 | 21 | A repository overiew with a short description of its tree/modularity |
22 | 22 |
|
23 | 23 | ## Release policy |
24 | 24 | Describe the release policy: |
25 | 25 |
|
26 | | -E.g. A release each Tensorflow release, multiple releases between two Tensorflow releases, etc. |
| 26 | +E.g. A release for each Tensorflow release, multiple releases between two Tensorflow releases, etc. |
27 | 27 |
|
28 | 28 | ## Installation |
29 | 29 | Quick instruction on how to install the packaged version of the repository |
30 | 30 |
|
31 | 31 | ## Docker |
32 | | -How to start to use the library inside a Docker container. |
33 | | -If the specific repo doesn't maintain its own Docker image we could route the user to install the package inside the Tensorflow official Docker container |
| 32 | +How to use the library inside a Docker container. |
| 33 | +If the specific repo doesn't maintain its own Docker image, consider directing users to install the package inside the Tensorflow official Docker container. |
34 | 34 |
|
35 | 35 | ## Build from source |
36 | 36 | Pointer to a specific CONTRIBUTING.md section |
37 | 37 |
|
38 | 38 | ## Contributing |
39 | 39 | Link to the CONTRIBUTING.md |
40 | 40 |
|
41 | | -## Support/community |
| 41 | +## Support/Community |
42 | 42 | Mailing list/Forum |
43 | 43 | Gitter |
44 | 44 |
|
45 | 45 | ## Extra info |
46 | | -Pleae add any extra info or references to others Markdown files in the specific repo |
| 46 | +Please add any extra info or references to important Markdown files or resources in the repo |
0 commit comments