A python package to perform collaborative filtering on emotion datasets. Compatible with Python 3 only.
pip install git+https://github.com/cosanlab/emotionCF.git
To develop this package or its documentation locally you will need to install a few extra dependencies.
pip install -r requirements-dev.txt
pytest -rs -n auto
New tests can be added in
Please format your code using black. If you've installed the development dependencies, then you can configure
git to tell if you any new changes are not formatted by setting up a pre-commit hook:
Create a new file called
pre-commitwith the following contents:
#!/bin/sh black --check .
Make sure the file is executable
chmod 775 pre-commit
Now anytime you try to commit new changes, git will automatically run black before the commit and warn you if certain files need to be formatted.
After installation above, simply run
mkdocs serve this the project root to start a hot-reloading server of the documentation at
To alter the layout of the docs site adjust settings in
mkdocs.yml. To add or edit pages simply create markdown files within the
You can use the
mkdocs gh-deploy command in order to build and push the documentation site to the github-pages branch of this repo.