"tests/vscode:/vscode.git/clone" did not exist on "eb1abee693104dd45376dbddd614320f2a0beb24"
Unverified Commit d5c41a90 authored by Vishnuvardhan Janapati's avatar Vishnuvardhan Janapati Committed by GitHub
Browse files

Creating issue templates for models (#8159)

* Create ISSUES.md

* Create 00-official-bug-issue.md

* Create 30-research-bug-issue.md

* Create 10-official-documentation-issue.md

* Update 00-official-bug-issue.md

* Create 20-official-feature-request-issue.md

* Update 00-official-bug-issue.md

* Updated 00-official-bug-issue.md

* Create 00-official-bug-issue.md

* Create 10-official-documentation-issue.md

* Create 20-official-feature-request-issue.md

* Create 30-research-bug-issue.md

* Create 40-research-documentation-issue.md

* Create 50-research-feature-request-issue.md

* Delete 00-official-bug-issue.md

* Create 00-official-bug-report-issue.md

* Update 10-official-documentation-issue.md

* Update 20-official-feature-request-issue.md

* Update and rename 30-research-bug-issue.md to 30-research-bug-report-issue.md

* Update 40-research-documentation-issue.md

* Update 50-research-feature-request-issue.md

Co-authored-by: Jaeyoun Kim <jaeyounkim@users.nore...
parent c0ece9cc
---
name: Bug Report for Official Models
about: Use this template for reporting a bug for projects under the “official” folder
labels: type:bug,models:official
---
<!--
Please make sure that this is a bug.
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.
Please go to Stack Overflow (http://stackoverflow.com/questions/tagged/tensorflow) for help and support.
-->
**System information**
- Have I written custom code (as opposed to using a stock example script provided in TensorFlow):
- OS Platform and Distribution (e.g., Linux Ubuntu 16.04):
- Mobile device (e.g., Pixel 4, Samsung Galaxy 10) if the issue happens on mobile device:
- TensorFlow installed from (source or binary):
- TensorFlow version (use command below):
- Python version:
- Bazel version (if compiling from source):
- GCC/Compiler version (if compiling from source):
- CUDA/cuDNN version:
- GPU model and memory:
<!--
You can collect some of this information using our environment capture (https://github.com/tensorflow/tensorflow/tree/master/tools/tf_env_collect.sh)
You can also obtain the TensorFlow version with:
1. TensorFlow 1.0
`python -c "import tensorflow as tf; print(tf.GIT_VERSION, tf.VERSION)"`
2. TensorFlow 2.0
`python -c "import tensorflow as tf; print(tf.version.GIT_VERSION, tf.version.VERSION)"`
-->
**Please provide the entire URL of the model you are using?**
<!-- (e.g., https://github.com/tensorflow/models/tree/master/official/nlp/bert) -->
**Describe the current behavior**
**Describe the expected behavior**
**Code to reproduce the issue**
<!-- Provide a reproducible test case that is the bare minimum necessary to generate the problem. -->
**Other info / logs**
<!-- Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached. -->
---
name: Documentation Issue for Official Models
about: Use this template for reporting a documentation issue for projects under the “official” folder
labels: type:docs,models:official
---
<!--
Please make sure that this is a documentation issue.
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.
Please go to Stack Overflow (http://stackoverflow.com/questions/tagged/tensorflow) for help and support.
-->
## Documentation URL(s) with the issue:
<!-- Please provide a link to the documentation entry, for example: https://github.com/tensorflow/models/tree/master/official/README.md -->
## Description of issue (what needs changing):
---
name: Feature request for Official Models
about: Use this template for raising a feature request for projects under the “official” folder
labels: type:feature,models:official
---
<!--
Please make sure that this is a feature request.
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.
Please go to Stack Overflow (http://stackoverflow.com/questions/tagged/tensorflow) for help and support.
-->
**Please provide the entire URL of the model you are using?**
<!-- (e.g., https://github.com/tensorflow/models/tree/master/official/nlp/bert) -->
**Describe the feature you request and the current behavior/state.**
**Are you willing to contribute it (Yes/No)?**
**Any other info.**
---
name: Bug Report for Research Models
about: Use this template for reporting a bug for projects under the “research” folder
labels: type:bug,models:research
---
<!--
Please make sure that this is a bug.
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.
Please go to Stack Overflow (http://stackoverflow.com/questions/tagged/tensorflow) for help and support.
The research models (https://github.com/tensorflow/models/tree/master/research) are a large collection of models implemented in TensorFlow by researchers. They are not officially supported. It is up to the individual researchers to maintain the models and/or provide support on issues and pull requests.
-->
**System information**
- Have I written custom code (as opposed to using a stock example script provided in TensorFlow):
- OS Platform and Distribution (e.g., Linux Ubuntu 16.04):
- Mobile device (e.g., Pixel 4, Samsung Galaxy 10) if the issue happens on mobile device:
- TensorFlow installed from (source or binary):
- TensorFlow version (use command below):
- Python version:
- Bazel version (if compiling from source):
- GCC/Compiler version (if compiling from source):
- CUDA/cuDNN version:
- GPU model and memory:
<!--
You can collect some of this information using our environment capture (https://github.com/tensorflow/tensorflow/tree/master/tools/tf_env_collect.sh)
You can also obtain the TensorFlow version with:
1. TensorFlow 1.0
`python -c "import tensorflow as tf; print(tf.GIT_VERSION, tf.VERSION)"`
2. TensorFlow 2.0
`python -c "import tensorflow as tf; print(tf.version.GIT_VERSION, tf.version.VERSION)"`
-->
**Please provide the entire URL of the model you are using?**
<!-- (e.g., https://github.com/tensorflow/models/tree/master/official/nlp/bert) -->
**Describe the current behavior**
**Describe the expected behavior**
**Code to reproduce the issue**
<!-- Provide a reproducible test case that is the bare minimum necessary to generate the problem. -->
**Other info / logs**
<!-- Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached. -->
---
name: Documentation Issue for Research Models
about: Use this template for reporting a documentation issue for projects under the “research” folder
labels: type:docs,models:research
---
<!--
Please make sure that this is a documentation issue.
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.
Please go to Stack Overflow (http://stackoverflow.com/questions/tagged/tensorflow) for help and support.
The research models (https://github.com/tensorflow/models/tree/master/research) are a large collection of models implemented in TensorFlow by researchers. They are not officially supported. It is up to the individual researchers to maintain the models and/or provide support on issues and pull requests.
-->
## Documentation URL(s) with the issue:
<!-- Please provide a link to the documentation entry, for example: https://github.com/tensorflow/models/blob/master/research/README.md -->
## Description of issue (what needs changing):
---
name: Feature Request for Research Models
about: Use this template for raising a feature request for projects under the “research” folder
labels: type:feature,models:research
---
<!--
Please make sure that this is a feature request.
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.
Please go to Stack Overflow (http://stackoverflow.com/questions/tagged/tensorflow) for help and support.
The research models (https://github.com/tensorflow/models/tree/master/research) are a large collection of models implemented in TensorFlow by researchers. They are not officially supported. It is up to the individual researchers to maintain the models and/or provide support on issues and pull requests.
-->
**Please provide the entire URL of the model you are using?**
<!-- (e.g., https://github.com/tensorflow/models/tree/master/official/nlp/bert) -->
**Describe the feature you request and the current behavior/state.**
**Are you willing to contribute it (Yes/No)?**
**Any other info.**
......@@ -2,7 +2,7 @@
1. It must be a bug, a feature request, or a significant problem with documentation (for small docs fixes please send a PR instead).
2. The form below must be filled out.
2. The required form must be filled out.
3. The issue should be related to the repo it is created in.
......@@ -16,6 +16,6 @@ TensorFlow developers respond to issues. We want to focus on work that benefits
We want to focus on the work that benefits the whole community, e.g., fixing bugs and adding features.
Individual support should be sought on Stack Overflow or other non-GitHub channels.
Individual support should be sought on [Stack Overflow](https://stackoverflow.com/questions/tagged/tensorflow-model-garden) or other non-GitHub channels.
It helps us to address bugs and feature requests in a timely manner.
It helps us to address bugs and feature requests in a timely manner.
\ No newline at end of file
---
name: Bug Issue
about: Use this template for reporting a bug for projects under the “official” folder
labels: models:official, type:bug
---
<em>Please make sure that this is a bug. As per our [GitHub Policy](https://github.com/jvishnuvardhan/models/blob/master/ISSUES.md), we only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub. tag:bug_template</em>
**System information**
- Have I written custom code (as opposed to using a stock example script provided in TensorFlow):
- OS Platform and Distribution (e.g., Linux Ubuntu 16.04):
- Mobile device (e.g. iPhone 8, Pixel 2, Samsung Galaxy) if the issue happens on mobile device:
- TensorFlow installed from (source or binary):
- TensorFlow version (use command below):
- Python version:
- Bazel version (if compiling from source):
- GCC/Compiler version (if compiling from source):
- CUDA/cuDNN version:
- GPU model and memory:
You can collect some of this information using our environment capture
[script](https://github.com/tensorflow/tensorflow/tree/master/tools/tf_env_collect.sh)
You can also obtain the TensorFlow version with: 1. TF 1.0: `python -c "import
tensorflow as tf; print(tf.GIT_VERSION, tf.VERSION)"` 2. TF 2.0: `python -c
"import tensorflow as tf; print(tf.version.GIT_VERSION, tf.version.VERSION)"`
**Describe the current behavior**
**Describe the expected behavior**
**Code to reproduce the issue**
Provide a reproducible test case that is the bare minimum necessary to generate the problem.
**Other info / logs**
Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached.
---
name: Documentation Issue
about: Use this template for reporting documentation issues for projects under under the “official” folder
labels: 'type:docs'
---
Thank you for submitting a TensorFlow documentation issue. Per our GitHub
policy, we only address code/doc bugs, performance issues, feature requests, and
build/installation issues on GitHub.
The TensorFlow docs are open source! To get involved, read the documentation
contributor guide: https://www.tensorflow.org/community/contribute/docs
## URL(s) with the issue:
Please provide a link to the documentation entry, for example:
https://www.tensorflow.org/api_docs/python/tf/keras/layers/LSTM
## Description of issue (what needs changing):
### Clear description
For example, why should someone use this method? How is it useful?
### Correct links
Is the link to the source code correct?
### Parameters defined
Are all parameters defined and formatted correctly?
### Returns defined
Are return values defined?
### Raises listed and defined
Are the errors defined? For example,
https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/feature_column/categorical_column_with_vocabulary_file#raises
### Usage example
Is there a usage example?
See the API guide: https://www.tensorflow.org/community/contribute/docs_ref
on how to write testable usage examples.
### Request visuals, if applicable
Are there currently visuals? If not, will it clarify the content?
### Submit a pull request?
Are you planning to also submit a pull request to fix the issue? See the docs
contributor guide: https://www.tensorflow.org/community/contribute/docs,
docs API guide: https://www.tensorflow.org/community/contribute/docs_ref and the
docs style guide: https://www.tensorflow.org/community/contribute/docs_style
---
name: Feature Request
about: Use this template for raising a feature request
labels: 'type:feature'
---
<em>Please make sure that this is a feature request. As per our [GitHub Policy](https://github.com/jvishnuvardhan/models/blob/master/ISSUES.md), we only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub. tag:feature_template</em>
**System information**
- TensorFlow version (you are using):
- Are you willing to contribute it (Yes/No):
**What is the top-level directory of the model you are using?**
**Describe the feature and the current behavior/state.**
**Will this change the current api? How?**
**Who will benefit with this feature?**
**Any Other info.**
---
name: Bug Issue
about: Use this template for reporting a bug or a performance issue.
labels: 'type:bug', 'research'
---
<em>Please make sure that this is a bug. As per our [GitHub Policy](https://github.com/jvishnuvardhan/models/blob/master/ISSUES.md), we only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub. tag:bug_template</em>
**System information**
- Have I written custom code (as opposed to using a stock example script provided in TensorFlow):
- OS Platform and Distribution (e.g., Linux Ubuntu 16.04):
- Mobile device (e.g. iPhone 8, Pixel 2, Samsung Galaxy) if the issue happens on mobile device:
- TensorFlow installed from (source or binary):
- TensorFlow version (use command below):
- Python version:
- Bazel version (if compiling from source):
- GCC/Compiler version (if compiling from source):
- CUDA/cuDNN version:
- GPU model and memory:
You can collect some of this information using our environment capture
[script](https://github.com/tensorflow/tensorflow/tree/master/tools/tf_env_collect.sh)
You can also obtain the TensorFlow version with: 1. TF 1.0: `python -c "import
tensorflow as tf; print(tf.GIT_VERSION, tf.VERSION)"` 2. TF 2.0: `python -c
"import tensorflow as tf; print(tf.version.GIT_VERSION, tf.version.VERSION)"`
**Describe the current behavior**
**Describe the expected behavior**
**Code to reproduce the issue**
Provide a reproducible test case that is the bare minimum necessary to generate the problem.
**Other info / logs**
Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment