Skip to content

Commit 98985e8

Browse files
westbenj2020westbenj2020
committed
Merge models into vendor/models/
1 parent 7a7f689 commit 98985e8

3,215 files changed

Lines changed: 744434 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎vendor/models/.github/ISSUE_TEMPLATE/00-official-bug-report-issue.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: "[Official Model] Bug Report"
3+
about: Use this template for reporting a bug for the “official” directory
4+
labels: type:bug,models:official
5+
6+
---
7+
8+
# Prerequisites
9+
10+
Please answer the following questions for yourself before submitting an issue.
11+
12+
- [ ] I am using the latest TensorFlow Model Garden release and TensorFlow 2.
13+
- [ ] I am reporting the issue to the correct repository. (Model Garden official or research directory)
14+
- [ ] I checked to make sure that this issue has not been filed already.
15+
16+
## 1. The entire URL of the file you are using
17+
18+
https://github.com/tensorflow/models/tree/master/official/...
19+
20+
## 2. Describe the bug
21+
22+
A clear and concise description of what the bug is.
23+
24+
## 3. Steps to reproduce
25+
26+
Steps to reproduce the behavior.
27+
28+
## 4. Expected behavior
29+
30+
A clear and concise description of what you expected to happen.
31+
32+
## 5. Additional context
33+
34+
Include any logs that would be helpful to diagnose the problem.
35+
36+
## 6. System information
37+
38+
- OS Platform and Distribution (e.g., Linux Ubuntu 16.04):
39+
- Mobile device name if the issue happens on a mobile device:
40+
- TensorFlow installed from (source or binary):
41+
- TensorFlow version (use command below):
42+
- Python version:
43+
- Bazel version (if compiling from source):
44+
- GCC/Compiler version (if compiling from source):
45+
- CUDA/cuDNN version:
46+
- GPU model and memory:
47+
48+
<!--
49+
Collect system information using our environment capture script.
50+
https://github.com/tensorflow/tensorflow/tree/master/tools/tf_env_collect.sh
51+
52+
You can also obtain the TensorFlow version with:
53+
54+
1. TensorFlow 1.0
55+
`python -c "import tensorflow as tf; print(tf.GIT_VERSION, tf.VERSION)"`
56+
57+
2. TensorFlow 2.0
58+
`python -c "import tensorflow as tf; print(tf.version.GIT_VERSION, tf.version.VERSION)"`
59+
-->

‎vendor/models/.github/ISSUE_TEMPLATE/10-official-documentation-issue.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: "[Official Model] Documentation Issue"
3+
about: Use this template for reporting a documentation issue for the “official” directory
4+
labels: type:docs,models:official
5+
6+
---
7+
8+
# Prerequisites
9+
10+
Please answer the following question for yourself before submitting an issue.
11+
12+
- [ ] I checked to make sure that this issue has not been filed already.
13+
14+
## 1. The entire URL of the documentation with the issue
15+
16+
https://github.com/tensorflow/models/tree/master/official/...
17+
18+
## 2. Describe the issue
19+
20+
A clear and concise description of what needs to be changed.

‎vendor/models/.github/ISSUE_TEMPLATE/20-official-feature-request-issue.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: "[Official Model] Feature request"
3+
about: Use this template for raising a feature request for the “official” directory
4+
labels: type:feature,models:official
5+
6+
---
7+
8+
# Prerequisites
9+
10+
Please answer the following question for yourself before submitting an issue.
11+
12+
- [ ] I checked to make sure that this feature has not been requested already.
13+
14+
## 1. The entire URL of the file you are using
15+
16+
https://github.com/tensorflow/models/tree/master/official/...
17+
18+
## 2. Describe the feature you request
19+
20+
A clear and concise description of what you want to happen.
21+
22+
## 3. Additional context
23+
24+
Add any other context about the feature request here.
25+
26+
## 4. Are you willing to contribute it? (Yes or No)

‎vendor/models/.github/ISSUE_TEMPLATE/30-research-bug-report-issue.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: "[Research Model] Bug Report"
3+
about: Use this template for reporting a bug for the “research” directory
4+
labels: type:bug,models:research
5+
6+
---
7+
# Prerequisites
8+
9+
Please answer the following questions for yourself before submitting an issue.
10+
11+
- [ ] I am using the latest TensorFlow Model Garden release and TensorFlow 2.
12+
- [ ] I am reporting the issue to the correct repository. (Model Garden official or research directory)
13+
- [ ] I checked to make sure that this issue has not already been filed.
14+
15+
## 1. The entire URL of the file you are using
16+
17+
https://github.com/tensorflow/models/tree/master/research/...
18+
19+
## 2. Describe the bug
20+
21+
A clear and concise description of what the bug is.
22+
23+
## 3. Steps to reproduce
24+
25+
Steps to reproduce the behavior.
26+
27+
## 4. Expected behavior
28+
29+
A clear and concise description of what you expected to happen.
30+
31+
## 5. Additional context
32+
33+
Include any logs that would be helpful to diagnose the problem.
34+
35+
## 6. System information
36+
37+
- OS Platform and Distribution (e.g., Linux Ubuntu 16.04):
38+
- Mobile device name if the issue happens on a mobile device:
39+
- TensorFlow installed from (source or binary):
40+
- TensorFlow version (use command below):
41+
- Python version:
42+
- Bazel version (if compiling from source):
43+
- GCC/Compiler version (if compiling from source):
44+
- CUDA/cuDNN version:
45+
- GPU model and memory:
46+
47+
<!--
48+
Collect system information using our environment capture script.
49+
https://github.com/tensorflow/tensorflow/tree/master/tools/tf_env_collect.sh
50+
51+
You can also obtain the TensorFlow version with:
52+
53+
1. TensorFlow 1.0
54+
`python -c "import tensorflow as tf; print(tf.GIT_VERSION, tf.VERSION)"`
55+
56+
2. TensorFlow 2.0
57+
`python -c "import tensorflow as tf; print(tf.version.GIT_VERSION, tf.version.VERSION)"`
58+
-->

‎vendor/models/.github/ISSUE_TEMPLATE/40-research-documentation-issue.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: "[Research Model] Documentation Issue"
3+
about: Use this template for reporting a documentation issue for the “research” directory
4+
labels: type:docs,models:research
5+
6+
---
7+
8+
# Prerequisites
9+
10+
Please answer the following question for yourself before submitting an issue.
11+
12+
- [ ] I checked to make sure that this issue has not been filed already.
13+
14+
## 1. The entire URL of the documentation with the issue
15+
16+
https://github.com/tensorflow/models/tree/master/research/...
17+
18+
## 2. Describe the issue
19+
20+
A clear and concise description of what needs to be changed.

‎vendor/models/.github/ISSUE_TEMPLATE/50-research-feature-request-issue.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: "[Research Model] Feature Request"
3+
about: Use this template for raising a feature request for the “research” directory
4+
labels: type:feature,models:research
5+
6+
---
7+
8+
# Prerequisites
9+
10+
Please answer the following question for yourself before submitting an issue.
11+
12+
- [ ] I checked to make sure that this feature has not been requested already.
13+
14+
## 1. The entire URL of the file you are using
15+
16+
https://github.com/tensorflow/models/tree/master/research/...
17+
18+
## 2. Describe the feature you request
19+
20+
A clear and concise description of what you want to happen.
21+
22+
## 3. Additional context
23+
24+
Add any other context about the feature request here.
25+
26+
## 4. Are you willing to contribute it? (Yes or No)

‎vendor/models/.github/ISSUE_TEMPLATE/60-questions-help-issue.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Questions and Help
3+
about: Use this template for Questions and Help.
4+
labels: type:support
5+
6+
---
7+
<!--
8+
As per our GitHub Policy (https://github.com/tensorflow/models/blob/master/ISSUES.md), we only address code bugs, documentation issues, and feature requests on GitHub.
9+
10+
We will automatically close questions and help related issues.
11+
12+
Please go to Stack Overflow (http://stackoverflow.com/questions/tagged/tensorflow-model-garden) for questions and help.
13+
14+
-->

‎vendor/models/.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎vendor/models/.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Description
2+
3+
> :memo: Please include a summary of the change.
4+
>
5+
> * Please also include relevant motivation and context.
6+
> * List any dependencies that are required for this change.
7+
8+
## Type of change
9+
10+
For a new feature or function, please create an issue first to discuss it
11+
with us before submitting a pull request.
12+
13+
Note: Please delete options that are not relevant.
14+
15+
- [ ] Bug fix (non-breaking change which fixes an issue)
16+
- [ ] Documentation update
17+
- [ ] TensorFlow 2 migration
18+
- [ ] New feature (non-breaking change which adds functionality)
19+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
20+
- [ ] A new research paper code implementation
21+
- [ ] Other (Specify)
22+
23+
## Tests
24+
25+
> :memo: Please describe the tests that you ran to verify your changes.
26+
>
27+
> * Provide instructions so we can reproduce.
28+
> * Please also list any relevant details for your test configuration.
29+
30+
**Test Configuration**:
31+
32+
## Checklist
33+
34+
- [ ] I have signed the [Contributor License Agreement](https://github.com/tensorflow/models/wiki/Contributor-License-Agreements).
35+
- [ ] I have read [guidelines for pull request](https://github.com/tensorflow/models/wiki/Submitting-a-pull-request).
36+
- [ ] My code follows the [coding guidelines](https://github.com/tensorflow/models/wiki/Coding-guidelines).
37+
- [ ] I have performed a self [code review](https://github.com/tensorflow/models/wiki/Code-review) of my own code.
38+
- [ ] I have commented my code, particularly in hard-to-understand areas.
39+
- [ ] I have made corresponding changes to the documentation.
40+
- [ ] My changes generate no new warnings.
41+
- [ ] I have added tests that prove my fix is effective or that my feature works.

‎vendor/models/.github/README_TEMPLATE.md‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
> :memo: A README.md template for releasing a paper code implementation to a GitHub repository.
2+
>
3+
> * Template version: 1.0.2020.170
4+
> * Please modify sections depending on needs.
5+
6+
# Model name, Paper title, or Project Name
7+
8+
> :memo: Add a badge for the ArXiv identifier of your paper (arXiv:YYMM.NNNNN)
9+
10+
[![Paper](http://img.shields.io/badge/Paper-arXiv.YYMM.NNNNN-B3181B?logo=arXiv)](https://arxiv.org/abs/...)
11+
12+
This repository is the official or unofficial implementation of the following paper.
13+
14+
* Paper title: [Paper Title](https://arxiv.org/abs/YYMM.NNNNN)
15+
16+
## Description
17+
18+
> :memo: Provide description of the model.
19+
>
20+
> * Provide brief information of the algorithms used.
21+
> * Provide links for demos, blog posts, etc.
22+
23+
## History
24+
25+
> :memo: Provide a changelog.
26+
27+
## Authors or Maintainers
28+
29+
> :memo: Provide maintainer information.
30+
31+
* Full name ([@GitHub username](https://github.com/username))
32+
* Full name ([@GitHub username](https://github.com/username))
33+
34+
## Table of Contents
35+
36+
> :memo: Provide a table of contents to help readers navigate a lengthy README document.
37+
38+
## Requirements
39+
40+
[![TensorFlow 2.1](https://img.shields.io/badge/TensorFlow-2.1-FF6F00?logo=tensorflow)](https://github.com/tensorflow/tensorflow/releases/tag/v2.1.0)
41+
[![Python 3.6](https://img.shields.io/badge/Python-3.6-3776AB)](https://www.python.org/downloads/release/python-360/)
42+
43+
> :memo: Provide details of the software required.
44+
>
45+
> * Add a `requirements.txt` file to the root directory for installing the necessary dependencies.
46+
> * Describe how to install requirements using pip.
47+
> * Alternatively, create INSTALL.md.
48+
49+
To install requirements:
50+
51+
```setup
52+
pip install -r requirements.txt
53+
```
54+
55+
## Results
56+
57+
[![TensorFlow Hub](https://img.shields.io/badge/TF%20Hub-Models-FF6F00?logo=tensorflow)](https://tfhub.dev/...)
58+
59+
> :memo: Provide a table with results. (e.g., accuracy, latency)
60+
>
61+
> * Provide links to the pre-trained models (checkpoint, SavedModel files).
62+
> * Publish TensorFlow SavedModel files on TensorFlow Hub (tfhub.dev) if possible.
63+
> * Add links to [TensorBoard.dev](https://tensorboard.dev/) for visualizing metrics.
64+
>
65+
> An example table for image classification results
66+
>
67+
> ### Image Classification
68+
>
69+
> | Model name | Download | Top 1 Accuracy | Top 5 Accuracy |
70+
> |------------|----------|----------------|----------------|
71+
> | Model name | [Checkpoint](https://drive.google.com/...), [SavedModel](https://tfhub.dev/...) | xx% | xx% |
72+
73+
## Dataset
74+
75+
> :memo: Provide information of the dataset used.
76+
77+
## Training
78+
79+
> :memo: Provide training information.
80+
>
81+
> * Provide details for preprocessing, hyperparameters, random seeds, and environment.
82+
> * Provide a command line example for training.
83+
84+
Please run this command line for training.
85+
86+
```shell
87+
python3 ...
88+
```
89+
90+
## Evaluation
91+
92+
> :memo: Provide an evaluation script with details of how to reproduce results.
93+
>
94+
> * Describe data preprocessing / postprocessing steps.
95+
> * Provide a command line example for evaluation.
96+
97+
Please run this command line for evaluation.
98+
99+
```shell
100+
python3 ...
101+
```
102+
103+
## References
104+
105+
> :memo: Provide links to references.
106+
107+
## License
108+
109+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
110+
111+
> :memo: Place your license text in a file named LICENSE in the root of the repository.
112+
>
113+
> * Include information about your license.
114+
> * Reference: [Adding a license to a repository](https://help.github.com/en/github/building-a-strong-community/adding-a-license-to-a-repository)
115+
116+
This project is licensed under the terms of the **Apache License 2.0**.
117+
118+
## Citation
119+
120+
> :memo: Make your repository citable.
121+
>
122+
> * Reference: [Making Your Code Citable](https://guides.github.com/activities/citable-code/)
123+
124+
If you want to cite this repository in your research paper, please use the following information.

0 commit comments

Comments
 (0)