Metadata-Version: 2.4
Name: aiaccel
Version: 2025.4
Summary: AIST Toolkit for Accelerating Machine Learning Research
Author-email: AIST <onishi-masaki@aist.go.jp>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: optuna>=3.4.0
Requires-Dist: omegaconf
Requires-Dist: hydra-core
Requires-Dist: colorama
Requires-Dist: lightning>=2.2.1
Requires-Dist: torch>=2.2.0
Requires-Dist: h5py
Requires-Dist: dask-jobqueue
Requires-Dist: rich
Requires-Dist: mypy ; extra == "dev"
Requires-Dist: myst-parser ; extra == "dev"
Requires-Dist: pre-commit ; extra == "dev"
Requires-Dist: pytest ; extra == "dev"
Requires-Dist: pytest-cov ; extra == "dev"
Requires-Dist: pytest-mock ; extra == "dev"
Requires-Dist: pytest-subprocess ; extra == "dev"
Requires-Dist: ruff ; extra == "dev"
Requires-Dist: sphinx ; extra == "dev"
Requires-Dist: sphinxcontrib-jquery ; extra == "dev"
Requires-Dist: sphinx-intl ; extra == "dev"
Requires-Dist: sphinx-fontawesome ; extra == "dev"
Requires-Dist: sphinx-rtd-theme ; extra == "dev"
Requires-Dist: sphinx-copybutton ; extra == "dev"
Requires-Dist: pydata-sphinx-theme ; extra == "dev"
Requires-Dist: sphinx_design ; extra == "dev"
Requires-Dist: types-colorama ; extra == "dev"
Requires-Dist: types-PyYAML ; extra == "dev"
Requires-Dist: undecorated ; extra == "dev"
Requires-Dist: pandas ; extra == "dev"
Requires-Dist: pandas-stubs ; extra == "dev"
Requires-Dist: matplotlib ; extra == "dev"
Requires-Dist: docstrfmt ; extra == "dev"
Requires-Dist: pytest-github-actions-annotate-failures ; extra == "github-actions"
Project-URL: documentation, https://aistairc.github.io/aiaccel/
Project-URL: repository, https://github.com/aistairc/aiaccel
Provides-Extra: dev
Provides-Extra: github-actions

<div align="center"><img src="https://raw.githubusercontent.com/aistairc/aiaccel/master/docs/image/logo_aiaccel.png" width="600"/></div>
<div align="center">
    <img src="https://img.shields.io/github/license/aistairc/aiaccel.svg" />
    <img src="https://img.shields.io/badge/Python-3.10-blue" />
    <a href="https://aistairc.github.io/aiaccel">
        <img src="https://github.com/aistairc/aiaccel/actions/workflows/gh-pages.yaml/badge.svg" />
    </a>
    <img src="https://github.com/aistairc/aiaccel/actions/workflows/ci.yaml/badge.svg" />
</div>

# AIST Toolkit for Accelerating Machine Learning Research

* **Research-Oriented**: designed to accelerate your research cycles written in Python
* **HPC Optimized**: intended to use in HPC clusters, including [AI Bridging Cloud Infrastructure (ABCI)](https://abci.ai/)
* **Highly Modular**: designed to let you pick up any part of aiaccel for your research project

# Key Features
* [PyTorch/Lightning Toolkit](https://aistairc.github.io/aiaccel/api_reference/torch.html): training toolkit for HPC clusters.
* [Hyperparameter Optimization (HPO)](https://aistairc.github.io/aiaccel/api_reference/hpo.html): ready-to-use HPO algorithms/tools.
* [OmegaConf Utilities](https://aistairc.github.io/aiaccel/api_reference/config.html): OmegaConf-based config utilities.


# Installation
```bash
pip install aiaccel
```
       
# Acknowledgement
* Part of this software was developed in a project commissioned by the New Energy and Industrial Technology Development Organization (NEDO).
* Part of this software was developed by using ABCI 3.0 provided by AIST and AIST Solutions.
* Part of this software was developed by using the TSUBAME4.0 supercomputer at Institute of Science Tokyo.

