Installation

Installation#

ML Research Tools can be installed from PyPI or directly from source using uv.

From Source#

To install from source:

git clone https://github.com/alexdremov/ml_research_tools.git
cd ml_research_tools
uv sync

Development Installation#

For development purposes, install with additional development dependencies:

uv sync --all-groups

This will install additional packages needed for development, such as testing and code quality tools.

Optional Dependencies#

The package has optional dependencies for different functionalities:

Documentation Tools#

For building documentation:

uv sync --group docs

All Optional Dependencies#

To install all optional dependencies:

uv sync --all-extras

Verifying Installation#

After installation, verify by running:

uv run ml_research_tools --help

This should display the help message with all available tools and options.

Requirements#

ML Research Tools requires:

  • Python 3.10 or later

  • uv for dependency management

Optional Dependencies#

Depending on which tools you use, you may need:

  • Redis (for caching functionality)

  • LaTeX (for the LaTeX-related tools)

  • Weights & Biases account (for W&B integration)

  • Kubernetes access (for Kubernetes tools)

Contents