retrieval_importance

Installation for development

  • Requires Python 3.9 and Rust to be available
  1. Clone the repository: git clone git@github.com:schelterlabs/retrieval_importance.git
  2. Change to the project directory: cd retrieval_importance
  3. Create a virtualenv: python3.9 -m venv venv
  4. Activate the virtualenv source venv/bin/activate
  5. Install the dev dependencies with pip install -r requirements-dev.txt
  6. Build the project maturin develop --release
  • Optional steps:
    • Run the tests with cargo test --release
    • Run the benchmarks with cargo bench
    • Run the Python tests python -m pytest
    • Start jupyter with jupyter notebook and run the example notebooks