Skip to content

Latest commit

 

History

History
130 lines (95 loc) · 4.97 KB

CONTRIBUTING.md

File metadata and controls

130 lines (95 loc) · 4.97 KB
Raw

How to Contribute

Thanks for thinking about contributing to our library !

Before you start

  • Comment on the issue that you plan to work on to avoid unnecessary duplication of work.
  • For major updates (for example, adding new FeatureConnectors): please respond on the issue (or create one if there isn't one) to explain your plan and give others a chance to discuss.
  • For smaller issues - please check the list of pending Pull Requests to avoid unnecessary duplication.

How you can help:

You can help in multiple ways:

  • Helping us fixing bugs and feature requests
  • Reproducing bugs reported by others: This helps us a lot.
  • Doing code reviews on the Pull Requests from the community.
  • Verifying that Pull Requests from others are working correctly (especially the ones that add new datasets).

Setup

Cloning the repo

If you want to contribute to our repository:

Clone or download the Tensorflow Datasets repository and install the repo locally.

git clone https://github.com/tensorflow/datasets.git
cd datasets/

Install the development dependencies:

pip install -e .  # Install minimal deps to use tensorflow_datasets
pip install -e .[dev]  # Install all deps required for development

Note there is also a pip3 install -e .[tests-all] to install all dataset-specific deps.

Visual Studio Code

When developing with Visual Studio Code, our repo comes with some pre-defined settings to help development (correct indentation, pylint,...).

Note: enabling test discovery in VS Code may fails due to some VS Code bugs #13301 and #6594. To solve the issues, you can look at the test discovery logs:

  • If you are encountering some TensorFlow warning message, try this fix.
  • If discovery fail due to missing import which should have been installed, please send a PR to update the dev pip install.

Datasets

Adding a public dataset to tensorflow-datasets is a great way of making it more accessible to the TensorFlow community.

See our Add a dataset doc to learn how to add a dataset.

Docstrings

Methods and classes should have clear and complete docstrings. Most methods (and all publicly-facing API methods) should have an Args: section that documents the name, type, and description of each argument. Argument lines should be formatted as arg_name: (`arg_type`) Description of arg.

References to tfds methods or classes within a docstring should go in backticks and use the publicly accessible path to that symbol. For example `tfds.core.DatasetBuilder`. Doing so ensures that the API documentation will insert a link to the documentation for that symbol.

Tests

To ensure that tensorflow-datasets is nice to use and nice to work on long-term, all modules should have clear tests for public members. All tests require:

  • Subclassing tfds.testing.TestCase
  • Calling tf.enable_v2_behavior() at the top-level just after the imports. This is to enable testing against TF 2.0.
  • Using the @tfds.testing.run_in_graph_and_eager_modes() decorator for all functionality that touches TF ops. To evaluate Tensor values in a way that is compatible in both Graph and Eager modes, use self.evaluate(tensors) or tfds.as_numpy.
  • End the test file with if __name__ == "__main__": tfds.testing.test_main().

Note that tests for DatasetBuilders are different and are documented in the guide to add a dataset.

Pull Requests

All contributions are done through Pull Requests here on GitHub.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution, this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.