Skip to content

Latest commit

 

History

History
212 lines (147 loc) · 7.16 KB

CONTRIBUTING.md

File metadata and controls

212 lines (147 loc) · 7.16 KB
Raw

Contribution guidelines

What to work on?

We have a public roadmap that lists what has been done, what we're currently doing, and what needs doing. There's also an icebox with high level ideas that need framing. You're welcome to pick anything that takes your fancy and that you deem important. Feel free to open a discussion if you want to clarify a topic and/or want to be formally assigned a task in the board.

Of course, you're welcome to propose and contribute new ideas. We encourage you to open a discussion so that we can align on the work to be done. It's generally a good idea to have a quick discussion before opening a pull request that is potentially out-of-scope.

Fork/clone/pull

The typical workflow for contributing to River is:

  1. Fork the main branch from the GitHub repository.
  2. Clone your fork locally.
  3. Commit changes.
  4. Push the changes to your fork.
  5. Send a pull request from your fork back to the original main branch.

Local setup

We encourage you to use a virtual environment. You'll want to activate it every time you want to work on River.

python -m venv .venv
source .venv/bin/activate

You can also create a virtual environment via conda:

conda create -n river -y python=3.9
conda activate river

Yet another option is to use pyenv:

pyenv virtualenv 3.10 river310
pyenv activate river310

You need a Rust compiler you can install it by following this link

Then, navigate to your cloned fork and install River and the required dependencies in development mode:

pip install -e ".[dev]"

Finally, install the pre-commit push hooks. This will run some code quality checks every time you push to GitHub.

pre-commit install --hook-type pre-push

You can optionally run pre-commit at any time as so:

pre-commit run --all-files

Making changes

You're now ready to make some changes. We strongly recommend that you to check out River's source code for inspiration before getting into the thick of it. How you make the changes is up to you of course. However we can give you some pointers as to how to test your changes. Here is an example workflow that works for most cases:

  • Create and open a Jupyter notebook at the root of the directory.
  • Add the following in the code cell:
%load_ext autoreload
%autoreload 2
  • The previous code will automatically reimport River for you whenever you make changes.
  • For instance, if a change is made to linear_model.LinearRegression, then rerunning the following code doesn't require rebooting the notebook:
from river import linear_model

model = linear_model.LinearRegression()

Creating a new estimator

  1. Pick a base class from the base module.
  2. Check if any of the mixin classes from the base module apply to your implementation.
  3. Make you've implemented the required methods, with the following exceptions:
    1. Stateless transformers do not require a learn_one method.
    2. In case of a classifier, the predict_one is implemented by default, but can be overridden.
  4. Add type hints to the parameters of the __init__ method.
  5. If possible provide a default value for each parameter. If, for whatever reason, no good default exists, then implement the _unit_test_params method. This is a private method that is meant to be used for testing.
  6. Write a comprehensive docstring with example usage. Try to have empathy for new users when you do this.
  7. Check that the class you have implemented is imported in the __init__.py file of the module it belongs to.
  8. When you're done, run the utils.check_estimator function on your class and check that no exceptions are raised.

Documenting your change

If you're adding a class or a function, then you'll need to add a docstring. We follow the Google docstring convention, so please do too.

To build the documentation, you need to install some extra dependencies:

pip install -e ".[docs]"
pip install git+https://github.com/MaxHalford/yamp

From the root of the repository, you can then run the make livedoc command to take a look at the documentation in your browser. This will run a custom script which parses all the docstrings and generate MarkDown files that MkDocs can render.

Adding a release note

All classes and function are automatically picked up and added to the documentation. The only thing you have to do is to add an entry to the relevant file in the docs/releases directory.

Building Cython extensions

make build-cython

Building Rust extensions

Debug settings:

make develop

Release settings:

make build-rust

After building the project by modifying the rust part of the codebase (changing the project architecture, renaming it, etc.), it happens that by importing river, the python process is killed. If this happens, we invite you to remove the following things and start a new build:

# remove all .so output from rust ie river/stats/_rust_stats.cpython*
rm -rf target
rm -rf river.egg-info
rm Cargo.lock
rm -rf build

Build Cython and Rust extensions

make build_all

Testing

Unit tests

These tests absolutely have to pass.

pytest

Static typing

These tests absolutely have to pass.

mypy river

Web dependent tests

This involves tests that need an internet connection, such as those in the datasets module which requires downloading some files. In most cases you probably don't need to run these.

pytest -m web

Notebook tests

You don't have to worry too much about these, as we only check them before each release. If you break them because you changed some code, then it's probably because the notebooks have to be modified, not the other way around.

make execute-notebooks

Making a new release

  1. Checkout main
  2. Run make execute-notebooks just to be safe
  3. Run the benchmarks
  4. Bump the version in river/__version__.py
  5. Tag and date the docs/releases/unreleased.md file
  6. Commit and push
  7. Wait for CI to run the unit tests
  8. Push the tag:
RIVER_VERSION=$(python -c "import river; print(river.__version__)")
echo $RIVER_VERSION
git tag $RIVER_VERSION
git push origin $RIVER_VERSION
  1. Wait for CI to ship to PyPI and publish the new docs
  2. Create a release:
RELEASE_NOTES=$(cat <<-END
- https://riverml.xyz/${RIVER_VERSION}/releases/${RIVER_VERSION}/
- https://pypi.org/project/river/${RIVER_VERSION}/
END
)
brew update && brew install gh
gh release create $RIVER_VERSION --notes $RELEASE_NOTES