A record-oriented data format which utilizes Protocol Buffers
Project description
# AimRecords - Record-oriented data storage
![GitHub Top Language](https://img.shields.io/github/languages/top/aimhubio/aimrecords) [![PyPI Package](https://img.shields.io/pypi/v/aimrecords?color=yellow)](https://pypi.org/project/aimrecords/) [![License](https://img.shields.io/badge/License-Apache%202.0-orange.svg)](https://opensource.org/licenses/Apache-2.0)
Library to effectively store the tracked experiment logs.
See the documentation [here](docs/index.md).
## 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](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
` ├── 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](https://www.python.org/dev/peps/pep-0008/) style guide for python code.
## 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
Built Distribution
Hashes for aimrecords-0.0.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 13d0a1297b5312908578aca82ef7503428ce75a3d027cd6339c5cce062ea8357 |
|
MD5 | 9fef97bcce037d31060c936af569b1ff |
|
BLAKE2b-256 | dfb05f317d7ba3a428b4c363ad7eeda92b2c6c493013c0c8b71f8c3dadc9462f |