Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

EmotionCF

Build Status Coverage Status Python Versions Platforms

A python package to perform collaborative filtering on emotion datasets. Compatible with Python 3 only.

Documentation Site

Installation

pip install git+https://github.com/cosanlab/emotionCF.git

Development

To develop this package or its documentation locally you will need to install a few extra dependencies.

Installation

pip install -r requirements-dev.txt

Testing

pytest -rs -n auto

New tests can be added in emotioncf/tests/.

Formatting

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:

  • cd .git/hooks

  • Create a new file called pre-commit with 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.

Documentation

Documentation is built with mkdocs using the mkdocs material theme, mkdocstrings extension, and mkdocs-jupyter plugins.

Live server

After installation above, simply run mkdocs serve this the project root to start a hot-reloading server of the documentation at http://localhost:8000.

To alter the layout of the docs site adjust settings in mkdocs.yml. To add or edit pages simply create markdown files within the docs/ folder.

Deploying

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.

About

A package to perform collaborative filtering on emotion datasets.

Resources

License

Releases

No releases published

Packages

No packages published

Languages