Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
37 lines (24 sloc) 1.16 KB

Contributing to Larq

👍 🎉 First off, thanks for taking the time to contribute! 👍 🎉

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub.

Project setup

To send a Pull Request please fork Larq Zoo on GitHub. After that clone it to a desired directory:

git clone https://github.com/my-username/larq-zoo.git

Install all required dependencies for local development by running:

cd larq-zoo # go into the directory you just cloned
pip install -e .[tensorflow] # Installs Tensorflow for CPU
# pip install -e .[tensorflow_gpu] # Installs Tensorflow for GPU
pip install -e .[test] # Installs all development dependencies

Run Unit tests

Inside the project directory run:

pytest .

Code style

We use black to format all of our code. We recommend installing it as a plugin for your favorite code editor.

You can’t perform that action at this time.