Skip to content

Latest commit

 

History

History
264 lines (182 loc) · 15.6 KB

CONTRIBUTING.md

File metadata and controls

264 lines (182 loc) · 15.6 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Table of Contents

Report Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open and recently closed issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

  • A reproducible test case or series of steps.
  • The version of our code being used.
  • Any modifications you've made relevant to the bug.
  • A description of your environment or deployment.

Contribute via Pull Requests (PRs)

Contributions via pull requests are much appreciated.

Before sending us a pull request, please ensure that:

  • You are working against the latest source on the master branch.
  • You check the existing open and recently merged pull requests to make sure someone else hasn't already addressed the problem.
  • You open an issue to discuss any significant work - we would hate for your time to be wasted.

Set up Your Development Environment [Optional, but Recommended]

  1. Set up the Cloud9 environment:
    1. Instance type: You'll need at least 4 GB of RAM to avoid running into memory issues. We recommend at least a t3.medium to run the unit tests. A larger host will reduce the chance of encountering resource limits.
    2. Follow the instructions at Creating a Cloud9 EC2 Environment to set up a Cloud9 EC2 environment.
  2. Expand the storage of the EC2 instance from 10GB to 20GB:
    1. Because you'll need a minimum of 11GB of disk storage on the EC2 instance to run the repository's unit tests, you'll need to expand your EC2 volume size. We recommend at least 20GB. A larger volume will reduce the chance of encountering resource limits.
    2. Follow the instructions at Modifying an EBS Volume Using Elastic Volumes (Console) to increase the EBS volume size associated with the newly created EC2 instance.
    3. Wait 5-10min for the new EBS volume increase to finalize.
    4. Allow EC2 to claim the additional space by stopping and then starting your EC2 host.

Pull Down the Code

  1. If you do not already have one, create a GitHub account by following the prompts at Join Github.
  2. Create a fork of this repository on GitHub. You should end up with a fork at https://github.com/<username>/sagemaker-python-sdk.
    1. Follow the instructions at Fork a Repo to fork a GitHub repository.
  3. Clone your fork of the repository: git clone https://github.com/<username>/sagemaker-python-sdk where <username> is your github username.

Run the Unit Tests

  1. Install tox using pip install tox
  2. Install coverage using pip install .[test]
  3. cd into the sagemaker-python-sdk folder: cd sagemaker-python-sdk or cd /environment/sagemaker-python-sdk
  4. Run the following tox command and verify that all code checks and unit tests pass: tox tests/unit

You can also run a single test with the following command: tox -e py310 -- -s -vv <path_to_file><file_name>::<test_function_name>

  • Note that the coverage test will fail if you only run a single test, so make sure to surround the command with export IGNORE_COVERAGE=- and unset IGNORE_COVERAGE
  • Example: export IGNORE_COVERAGE=- ; tox -e py310 -- -s -vv tests/unit/test_estimator.py::test_sagemaker_model_s3_uri_invalid ; unset IGNORE_COVERAGE

Run the Integration Tests

Our CI system runs integration tests (the ones in the tests/integ directory), in parallel, for every Pull Request. You should only worry about manually running any new integration tests that you write, or integration tests that test an area of code that you've modified.

  1. Follow the instructions at Set Up the AWS Command Line Interface (AWS CLI).
  2. To run a test, specify the test file and method you want to run per the following command: tox -e py310 -- -s -vv <path_to_file><file_name>::<test_function_name>
    • Note that the coverage test will fail if you only run a single test, so make sure to surround the command with export IGNORE_COVERAGE=- and unset IGNORE_COVERAGE
    • Example: export IGNORE_COVERAGE=- ; tox -e py310 -- -s -vv tests/integ/test_tf_script_mode.py::test_mnist ; unset IGNORE_COVERAGE

If you are writing or modifying a test that creates a SageMaker job (training, tuner, or transform) or endpoint, it's important to assign a concurrency-friendly job_name (or endpoint_name), or your tests may fail randomly due to name collisions. We have a helper method sagemaker.utils.unique_name_from_base(base, max_length) that makes test-friendly names. You can find examples of how to use it here and here, or by searching for "unique_name_from_base" in our test code.

Make and Test Your Change

  1. Create a new git branch: 
    git checkout -b my-fix-branch master
  2. Make your changes, including unit tests and, if appropriate, integration tests.
    1. Include unit tests when you contribute new features or make bug fixes, as they help to:
      1. Prove that your code works correctly.
      2. Guard against future breaking changes to lower the maintenance cost.
    2. Please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
  3. Run all the unit tests as per Run the Unit Tests, and verify that all checks and tests pass.
    1. Note that this also runs tools that may be necessary for the automated build to pass (ex: code reformatting by 'black').
  4. If your changes include documentation changes, please see the Documentation Guidelines.
  5. If you include integration tests, do not mark them as canaries if they will not run in all regions.

Commit Your Change

We use commit messages to update the project version number and generate changelog entries, so it's important for them to follow the right format. Valid commit messages include a prefix, separated from the rest of the message by a colon and a space. Here are a few examples:

feature: support VPC config for hyperparameter tuning
fix: fix flake8 errors
documentation: add MXNet documentation

Valid prefixes are listed in the table below.

Prefix Use for...
breaking Incompatible API changes.
deprecation Deprecating an existing API or feature, or removing something that was previously deprecated.
feature Adding a new feature.
fix Bug fixes.
change Any other code change.
documentation Documentation changes.

Some of the prefixes allow abbreviation ; break, feat, depr, and doc are all valid. If you omit a prefix, the commit will be treated as a change.

For the rest of the message, use imperative style and keep things concise but informative. See How to Write a Git Commit Message for guidance.

Send a Pull Request

GitHub provides additional document on Creating a Pull Request.

Please remember to:

  • Use commit messages (and PR titles) that follow the guidelines under Commit Your Change.
  • Send us a pull request, answering any default questions in the pull request interface.
  • Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

Documentation Guidelines

We use reStructuredText (RST) for most of our documentation. For a quick primer on the syntax, see the Sphinx documentation.

In this repository, we have two main categories of documentation: overviews and API references. "How to" tutorials are housed in the Amazon SageMaker Examples repository. Overviews and API references are discussed in more detail below.

Here are some general guidelines to follow when writing either kind of documentation:

  • Use present tense.
    • 👍 "The estimator fits a model."
    • 👎 "The estimator will fit a model."
  • When referring to an AWS product, use its full name in the first invocation. (This applies only to prose; use what makes sense when it comes to writing code, etc.)
    • 👍 "Amazon S3"
    • 👎 "s3"
  • Provide links to other ReadTheDocs pages, AWS documentation, etc. when helpful. Try to not duplicate documentation when you can reference it instead.

Overviews

This section refers to documentation that discusses a specific topic or feature to help the reader deepen their understanding, and may include short snippets of how to do specific tasks. Examples include "Amazon SageMaker Debugger" and "Use MXNet with the SageMaker Python SDK."

The goal of these documents is to explain basic usage. This includes the general purpose of the topic or feature, and common ways to use the SageMaker Python SDK in that context.

This type of documentation should not be a step-by-step tutorial. That is better suited for the example notebooks. Instead, keep the content focused on the unique aspects of the feature. For example, if one is writing specifically about deploying models, there is no need to also include instructions on how to train a model first. In this case, consider linking to existing documentation about training models and any other prerequisites.

Lastly, in addition to the general guidelines listed above:

  • Use the imperative mood for headings.
    • 👍 "Prepare a Training Script"
    • 👎 "Preparing a Training Script"
  • Don’t refer to features as "new" - they might be at the time of writing, but they won’t always be!

API References (docstrings)

The API references are generated from docstrings. A docstring is the comment in the source code that describes a module, class, function, or variable.

def foo():
    """This comment is a docstring for the function foo."""

We use Google-style docstrings. There should be a docstring for every public module, class, and function. For functions, make sure your docstring covers all of the arguments, exceptions, and any other relevant information. When possible, link to classes and functions, e.g. use ":class:~`sagemaker.session.Session`" over just "Session."

If a parameter of a function has a default value, please note what the default is. If that default value is None, it can also be helpful to explain what happens when the parameter is None. If **kwargs is part of the function signature, link to the parent class(es) or method(s) so that the reader knows where to find the available parameters.

For an example file with docstrings, see the processing module.

To have a class's docstrings included in the API reference, it needs to be included in one of the files in the doc/ folder. For example, see the Processing API reference.

Build and Test Documentation

To build the Sphinx docs, run the following command in the doc/ directory:

make html

You can then find the generated HTML files in doc/_build/html/.

To check both the README and API documentation for build errors, you can run the following:

tox -e twine,sphinx

Find Contributions to Work On

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opensource-codeofconduct@amazon.com with any additional questions or comments.

Security Issue Notifications

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public github issue.

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.

We may ask you to sign a Contributor License Agreement (CLA) for larger changes.