examples-utils

Utils and common code for Graphcore's example applications.

Command line interface

The package includes some command line interface (CLI) utils. For more details, refer to the CLI help:

python -m examples_utils --help

Installation

The examples-utils package can be installed from source via pip:

python -m pip install git+https://github.com/graphcore/examples-utils.git

By default, this will only install a minimal set of requirements. To benchmark notebooks you must install the "jupyter" set of requirements:

python -m pip install "examples-utils[jupyter] @ git+https://github.com/graphcore/examples-utils.git"

The latest_stable tag refers to a commit that is tested and should be reliable, but also updates automatically as fixes and features are added. You can use this by adding:

examples-utils @ git+https://github.com/graphcore/examples-utils@latest_stable

to your requirements.txt file

Benchmarking

The benchmarking sub-package is used for running the benchmarks that are provided with example applications in the examples repository. For more information, refer to the benchmarks README.

Notebook logging

The Graphcore logger for notebooks, GCLogger, is an IPython extension module that tracks user behaviour within the Jupyter notebooks we provide via Paperspace. For more information, refer to the notebook logging README

Pre-Commit Hooks

python -m pip install "examples-utils[precommit] @ https://github.com/graphcore/examples-utils.git"

Development

• Reformat code to the repo standard with make lint
• Use Google-style docstrings
• Do not push to the master branch. Make changes through GitHub PR requests.

Licence

See file LICENSE