Skip to main content

# 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/README.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.

Metadata

Release files for aimrecords 0.0.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aimrecords 0.0.7
File Size Uploaded
aimrecords-0.0.7.tar.gz 12.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aimrecords 0.0.7
File Interpreter ABI Platform
aimrecords-0.0.7-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 41.3 kB

Release files / aimrecords-0.0.7.tar.gz

Download URL aimrecords-0.0.7.tar.gz
Size 12.7 kB
Tags Source
SHA-256 checksum
How to use checksums
9b562fa5b5109b4b3dd4f83be0061cadbac63fa8031f281b8b5c8ae29967072f
BLAKE2b-256 checksum
How to use checksums
c91021182ef96acbd9a5ca4008556ba8590cbc1af833eccbf59d53308fa6d928
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.3.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/2.7.15

Release files / aimrecords-0.0.7-py2.py3-none-any.whl

Download URL aimrecords-0.0.7-py2.py3-none-any.whl
Size 28.7 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
b9276890891c5fd68f817e20fc5d466a80c01e22fa468eaa979331448a75d601
BLAKE2b-256 checksum
How to use checksums
5313207ebb5b2315640a68378c31cb31cfe1182373d11a813bd52219c83700a7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.3.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/2.7.15
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page