Contribution Guide¶

Join us to write tutorials! If you have a tutorial or just an idea, please feel free to create a GitHub issue with your suggestion. We will get back to you as soon as possible.

Installation¶

1. Fork / Clone this repository¶

Get the evidently code example:

git clone https://github.com/mlrepa/mlrepa-library.git

2. Create virtual environment¶

Create virtual environment named .venv and install python libraries

python3 -m venv .venv
echo "export PYTHONPATH=$PWD" >> .venv/bin/activate
source .venv/bin/activate
pip install -r requirements.txt

3. Run local mkdocs server to check your changes¶

mkdocs serve

4. Commit changes and create a Pull Request to the main repository¶

We will get back to you as soon as possible. Looking forward to requesting from you!

¶

banner