Prosemble

Overview

Prosemble is a Python library for prototype-based machine learning models.

Installation

Prosemble can be installed using pip:

pip install prosemble

If you have installed Prosemble before and want to upgrade to the latest version, you can run the following command in your terminal:

pip install -U prosemble

To install the latest development version directly from the GitHub repository:

pip install git+https://github.com/naotoo1/prosemble

Development Environment

Prosemble provides a fully reproducible development environment using Nix and devenv. Once you have installed Nix and devenv, you can do the following:

mkdir -p ~/.config/nix
echo "experimental-features = nix-command flakes" >> ~/.config/nix/nix.conf
nix profile install --accept-flake-config "github:cachix/devenv/latest"

Then clone and enter the project directory:

git clone https://github.com/naotoo1/prosemble.git
cd prosemble

Activate the reproducible development environment with:

devenv shell

You may optionally consider using direnv for automatic shell activation when entering the project directory.

To install Prosemble in development mode, follow these steps to set up your environment with all the necessary dependencies while ensuring the package is installed with live code editing capabilities. To run the local reproducible development environment, execute the command:

setup-python-env

To run Prosemble inside a reproducible Docker container, execute:

# Build the Docker container
create-cpu-container
# Run the container 
run-cpu-container

When working with Prosemble in development mode, changes to the code take effect immediately without reinstallation. Use git pull to get the latest updates from the repository. Run tests after making changes to verify functionality

Citation

If you use Prosemble in your research, please cite it using the following BibTeX entry:

@misc{Otoo_Prosemble_2022,
  author       = {Otoo, Nana Abeka},
  title        = {Prosemble},
  year         = {2022},
  publisher    = {GitHub},
  journal      = {GitHub repository},
  howpublished = {\url{https://github.com/naotoo1/Prosemble}},
}