Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.59 KB

README.md

File metadata and controls

52 lines (34 loc) · 1.59 KB

AimRecords - Record-oriented data storage

GitHub Top Language PyPI Package License

Library to effectively store the tracked experiment logs.

See the documentation here.

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

We suggest to use virtual environment for managing local dependencies.

To start development first install all dependencies:

pip install -r requirements.txt

Project Structure

├── aimrecords  <-----------  main project code
│   ├── artifact_storage  <-  manage storage of artifacts
│   └── record_storage  <---  manage records storage of a single artifact
├── docs  <-----------------  data format documentation
├── examples  <-------------  example usages of aimrecords
└── tests

Running the tests

Run tests via command pytest in the root folder.

Code Style

We follow pep8 style guide for python code.

Contributing

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