Metadata-Version: 2.1
Name: aim-cli
Version: 2.0.1
Summary: Version control for AI
Home-page: UNKNOWN
License: UNKNOWN
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.5.2
Requires-Dist: click (>=6.7)
Requires-Dist: paramiko (>=2.6.0)
Requires-Dist: GitPython (>=3.0.4)
Requires-Dist: requests (>=2.0.0)
Requires-Dist: psutil (>=5.6.7)
Requires-Dist: py3nvml (>=0.2.5)
Requires-Dist: docker (>=4.1.0)
Requires-Dist: aimrecords (>=0.0.3)
Requires-Dist: protobuf (>=3.11.0)


# 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


