Skip to main content

Platform to version model, data, parameters alongside git versioned source code

Project description




Gitter PyPi lgtm

A version control system for software 2.0.


Complete Documentation: stockroom.page


Introduction

Stockroom is a platform to version models, data, parameters, experiment artifacts etc. alongside git versioned source code.

  • It is easy. The APIs are very similar to dictionaries in python
  • It works alongside Git - in case you need to version source code as well. It's OK if you don't.
  • High performance, thanks to the amazing hangar library
  • Integration with PyTorch and it's ecosystem, so that you don't need to write the complex pipeline code.

Why

One important motivation behind the initial design of stockroom is to avoid users learning another tool for versioning. We try to make the APIs as minimal and familiar as possible. Similar to other versioning tools, stockroom let "git" does checkout and rely on "git" to move between branches/commits. But unlike other tools, we channel your data access through the smart API so that we don't need to move the huge data files around when you traverse between commits.

Installation

$ pip install stockroom

Example

from stockroom import StockRoom

stock = StockRoom(write=True)
model.load_state_dict(stock.model['resnet50'])
for e in range(epochs):
    for i in range(limit):
        optimizer.zero_grad()
        x, y = stock.data['dataset_name', i]
        out = model(x)
        loss = criterion(out, y)
        loss.backward()
        optimizer.step()
        if loss < previous_loss:
            stock.experiment['loss'] = loss.item()
            stock.model['resnet50'] = model.state_dict()
            stock.commit('adding a better model')

Contributing

We'd love to have you in the contributors list. Do check out the contributors guide before submitting a PR. Here is our latest #Hall-Of-Fame

License

This project is licensed under the terms of the Apache Software License 2.0

Project details


Download files

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

Source Distribution

stockroom-0.2.1.tar.gz (119.1 kB view details)

Uploaded Source

Built Distribution

stockroom-0.2.1-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

Details for the file stockroom-0.2.1.tar.gz.

File metadata

  • Download URL: stockroom-0.2.1.tar.gz
  • Upload date:
  • Size: 119.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0.post20200714 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.3

File hashes

Hashes for stockroom-0.2.1.tar.gz
Algorithm Hash digest
SHA256 2a9dfd53a48a74e8610821ad011e4de9d011c65ec6d017d966d3a7191b111966
MD5 5b66b454db93e06f70f98eb6f57e0890
BLAKE2b-256 52414a0d859a2e20aeeacc771485c8f4cad8e5befb8929ac657d4d1891f42831

See more details on using hashes here.

File details

Details for the file stockroom-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: stockroom-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 17.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0.post20200714 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.3

File hashes

Hashes for stockroom-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 936867846e906b6b0e0a692002836fe4e55d8cad89635e132d63c41d61181c40
MD5 c36477da469979a7cd796957493a7566
BLAKE2b-256 6280191c2a917e9bdbe571a5f7e5d5dcaccb9effd954547374e871993482512f

See more details on using hashes here.

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