Skip to content

Commit 4896a2f

Browse files
authored
Merge pull request #44 from ml-gde/contribute
Update CONTRIBUTING.md to include reference blog posts and more
2 parents 9543235 + 83b452d commit 4896a2f

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

CONTRIBUTING.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,21 @@ Thanks for your interest in contributing to **E2E TensorFlow Lite Tutorials**!
44

55
Please follow these steps when contributing:
66

7-
Step 1. (Optional) Propose a project idea with either a brief description or an overview page if you wish to add more context about it.
8-
Step 2. (Optional) Create issues for requesting help, in general in these areas:
7+
**Step 1. (Optional)** Propose a project idea with either a brief description or an overview page if you wish to add more context about it.
8+
**Step 2. (Optional)** Create issues for requesting help, in general in these areas:
99

1010
* Model training
11-
* Model conversion to tflite (and add metadata) <-- tflite model can reside in a team members' GitHub, in your project repo or on TFHub. Please validate the tflite with metadata in the Android app especially if you are publishing it to TFHub for wider adoption.
11+
* Model conversion to tflite (and add metadata) <-- tflite model can reside in a team members' GitHub, in your project repo or on TFHub. Please validate the tflite model with metadata in the Android app especially if you are publishing it to TensorFlow Hub for wider adoption.
1212
* Android app
1313
* iOS app
14-
* write an E2E tutorial
14+
* Write an E2E tutorial
15+
* Here is an example - [How to Create a Cartoonizer with TensorFlow Lite](https://blog.tensorflow.org/2020/09/how-to-create-cartoonizer-with-tf-lite.html).
16+
17+
*Note that you can also write a blog post about model conversion processes that are generally non-trivial. Here's a good example - [Optimizing MobileDet for Mobile Deployments](https://sayak.dev/mobiledet-optimization/). If you want to benchmark multiple TensorFlow Lite models and write a blog post comparing their performance aspects we welcome that as well. Refer to this blog post - [A Battle of Text Detectors for Mobile Deployments: CRAFT vs. EAST](https://sayak.dev/optimizing-text-detectors/) if you are interested in writing such materials.*
1518

16-
Step 3. If you are interested in helping out, please create a project repo and add the link to the E2E TFLite Tutorials README. Update project to "In Progress" section.
17-
Step 4. After project is completed, move from "In progress " to "Completed" section on E2E TFLite Tutorials. And request with a PR to add your project to [awesome-tflite].
19+
**Step 3.** If you are interested in helping out, please create a project repo and add the link to the E2E TFLite Tutorials README. Update project to "In Progress" section.
20+
**Step 4.** After project is completed, move from "In progress " to "Completed" section on E2E TFLite Tutorials. And request with a PR to add your project to [awesome-tflite].
1821

1922
When createing a PR, please make sure to:
2023
* Provide a meaningful title such as "Update README.md to [action]" and do not title it as "Update README.md".
21-
* Make sure there are no broken links.
24+
* Make sure there are no broken links.

0 commit comments

Comments
 (0)