Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md to include reference blog posts and more #44

Merged
merged 2 commits into from
Dec 5, 2020
Merged

Update CONTRIBUTING.md to include reference blog posts and more #44

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31d0107
Update CONTRIBUTING.md
sayakpaul Dec 3, 2020
83b452d
Update CONTRIBUTING.md
sayakpaul Dec 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,21 @@ Thanks for your interest in contributing to **E2E TensorFlow Lite Tutorials**!

Please follow these steps when contributing:

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.
Step 2. (Optional) Create issues for requesting help, in general in these areas:
**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.
**Step 2. (Optional)** Create issues for requesting help, in general in these areas:

* Model training
* 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.
* 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.
* Android app
* iOS app
* write an E2E tutorial
* Write an E2E tutorial
* 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).

*Note that you can also write a blog post about model conversion processes that are generally non-trivial. Here's a [good example](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](https://sayak.dev/optimizing-text-detectors/) if you are interested in writing such materials.*

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.
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].
**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.
**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].

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