https://github.com/kempnerinstitute/tatm
Python Package for the Kempner AI Testbed
https://github.com/kempnerinstitute/tatm
Last synced: 8 months ago
JSON representation
Python Package for the Kempner AI Testbed
- Host: GitHub
- URL: https://github.com/kempnerinstitute/tatm
- Owner: KempnerInstitute
- License: mit
- Created: 2024-08-15T19:23:19.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2025-03-14T18:48:13.000Z (over 1 year ago)
- Last Synced: 2025-04-06T15:28:30.684Z (about 1 year ago)
- Language: Python
- Homepage: https://kempnerinstitute.github.io/tatm/
- Size: 6.16 MB
- Stars: 5
- Watchers: 6
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# `tatm` Kempner AI Testbed Library
`tatm` (**T**ransformer **A**ssistive **T**estbed **M**odule) is a Python library that provides a set of tools to assist in the development of transformer-based (and other architecture) models for foundation model research on on-premise clusters. It currently provides an interface for accessing and manipulating data, and in the future will include features for training models and evaluating models. The library is designed to be modular and extensible, allowing for easy integration of new models, datasets, and training frameworks.
## Documentation
[](https://tatm.readthedocs.io/en/latest/?badge=latest)
- [Stable Version Documentation](https://tatm.readthedocs.io/en/latest/index.html)
- [Getting Started](https://tatm.readthedocs.io/en/latest/getting_started.html)
- [Example Working with a Text Dataset](https://tatm.readthedocs.io/en/latest/text_dataset.html)
- [Nightly Version Documentation](https://kempnerinstitute.github.io/tatm/)
- [Getting Started](https://kempnerinstitute.github.io/tatm/getting_started.html)
- [Example Working with a Text Dataset](https://kempnerinstitute.github.io/tatm/text_dataset.html)
## Installation
### Requirements
- Python 3.10 is the minimum supported version.
- `tatm` depends on pytorch, which depends on CUDA. It is recommended to pre-install both pytorch and CUDA prior to installing `tatm`. Instructions for installing pytorch can be found [here](https://pytorch.org/get-started/locally/).
### Installation
#### Installing from GitHub
To install the latest stable version of `tatm` from GitHub, run the following command:
```bash
pip install git+ssh://git@github.com/KempnerInstitute/tatm.git@main
```
To install the latest development version of `tatm` from GitHub, run the following command:
```bash
pip install git+ssh://git@github.com/KempnerInstitute/tatm.git@dev
```
For a specific past version of `tatm`, replace `main` or `dev` with the desired version number (i.e. `v0.1.0`).
#### Installing from PyPI
The package is not yet available on PyPI. Stay tuned for updates!