Skip to main content

Version control for AI

Project description

# AIM - Version control for AI

![GitHub Top Language](https://img.shields.io/github/languages/top/aimhubio/aim) [![PyPI Package](https://img.shields.io/pypi/v/aim-cli?color=yellow)](https://pypi.org/project/aim-cli/) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

Tracks and versions AI training runs along with the metadata and the models.

See the documentation [here](https://docs.aimstack.io).

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Requirements

  • Python >= 3.5.0

We suggest to use [virtual environment](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments) for managing local dependencies.

To start development first install all dependencies:

`bash pip install -r requirements.txt `

### Project Structure

` ├── aim <---------------- main project code │   ├── cli <------------- command line interface │   ├── engine <---------- business logic │   ├── sdk <------------- Python SDK │   ├── artifacts <------- managing tracked data │   └── version_control <- managing files and code ├── examples <------------ example usages of aim SDK └── tests `

## Running the tests

Run tests via command python -m unittest discover -s tests in the root folder.

### Code Style We follow [pep8](https://www.python.org/dev/peps/pep-0008/) style guide for python code. We use [autopep8](https://pypi.org/project/autopep8/) and [pycodestyle](https://pypi.org/project/pycodestyle/) to enable checking and formatting Python code.

To check code styles, run pycodestyle . in the root folder.

To auto format, run autopep8 –in-place –recursive –aggressive –aggressive . in the root folder.

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/aimhubio/aim/tags).

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aim-cli-2.0.2rc1.tar.gz (30.1 kB view hashes)

Uploaded Source

Built Distribution

aim_cli-2.0.2rc1-py2.py3-none-any.whl (49.6 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page