gmtorch 0.0.1.dev0

Probabilistic Generative AI Using Gaussian Mixture

gmtorch

Probabilistic Generative AI Using Gaussian Mixture

Installing

To install this package, run:

pip install gmtorch

Using

Example usage:

import gmtorch

...

Contributing

Prerequisites

1. Generate an SSH key and add the SSH key to your GitLab account.

2. Configure SSH to automatically load your SSH keys:

   cat << EOF >> ~/.ssh/config
   
   Host *
     AddKeysToAgent yes
     IgnoreUnknown UseKeychain
     UseKeychain yes
     ForwardAgent yes
   EOF
   

3. Install Docker Desktop.

4. Install VS Code and VS Code's Dev Containers extension. Alternatively, install PyCharm.

5. Optional: install a Nerd Font such as FiraCode Nerd Font and configure VS Code or PyCharm to use it.

Development environments

The following development environments are supported (Note: with non-Nvidia GPUs use the 2. method):

1. ⭐️ VS Code Dev Container (with container volume): click on Open in Dev Containers to clone this repository in a container volume and create a Dev Container with VS Code.

2. ⭐️ uv: clone this repository and run the following from root of the repository:

   On Linux or macOS:

   # Download and install uv
   curl -LsSf https://astral.sh/uv/install.sh | sh
   
   # Create and install a virtual environment
   uv sync --python 3.12 --all-extras
   
   # Activate the virtual environment
   source .venv/bin/activate 
   
   # Install the pre-commit hooks
   pre-commit install --install-hooks
   

   On Windows (PowerShell):

   # Download and install uv
   powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
   
   # Create and install a virtual environment
   uv sync --python 3.12 --all-extras
   
   # Activate the virtual environment
   .venv\Scripts\activate
   
   # Install the pre-commit hooks
   pre-commit install --install-hooks
   

3. VS Code Dev Container: clone this repository, open it with VS Code, and run Ctrl/⌘ + ⇧ + P → Dev Containers: Reopen in Container.

4. PyCharm Dev Container: clone this repository, open it with PyCharm, create a Dev Container with Mount Sources, and configure an existing Python interpreter at /opt/venv/bin/python.

Developing

• This project follows the Conventional Commits standard to automate Semantic Versioning and Keep A Changelog with Commitizen.
• Run poe from within the development environment to print a list of Poe the Poet tasks available to run on this project.
• Run uv add {package} from within the development environment to install a run time dependency and add it to pyproject.toml and uv.lock. Add --dev to install a development dependency.
• Run uv sync --upgrade from within the development environment to upgrade all dependencies to the latest versions allowed by pyproject.toml. Add --only-dev to upgrade the development dependencies only.
• Run cz bump to bump the package's version, update the CHANGELOG.md, and create a git tag. Then push the changes and the git tag with git push origin branch-name --tags.
• Workflow: create a feature branch from develop -> create a merge request to develop -> on major releases, create a merge request from develop to main.

Versioning

• Stable releases on main branch use Semantic Versioning.
• Development releases on develop branch use the current version with .devN suffix, where N is the number of published development releases so far for the current version.
• Docker images use either develop or latest tags for publishing from develop or main branches, respectively.