Skip to main content

A framework of tools to structure, configure and drive deep learning projects

Project description

serotiny

While going about the work of building deep learning projects, several simultaneous problems seemed to emerge:

  • How do we reuse as much work from previous projects as possible, and focus on building the part of the project that makes it distinct?
  • How can we automate the generation of new models that are based on existing models, but vary in a crucial yet non-trivial way?
  • When generating a multiplicity of related models, how can we keep all of the results, predictions, and analyses straight?
  • How can the results from any number of trainings and predictions be compared and integrated in an insightful yet generally applicable way?

Serotiny arose from the need to address these issues and convert the complexity of deep learning projects into something simple, reproducible, configurable, and automatable at scale.

Serotiny is still a work-in-progress, but as we go along the solutions to these problems become more clear. Maybe you've run into similar situations? We'd love to hear from you.

Overview

serotiny is a framework and set of tools to structure, configure and drive deep learning projects, developed with the intention of streamlining the lifecycle of deep learning projects at Allen Institute for Cell Science.

It achieves this goal by:

  • Standardizing the structure of DL projects
  • Relying on the modularity afforded by this standard structure to make DL projects highly configurable, using hydra as the framework for configuration
  • Making it easy to adopt best-practices and latest-developments in DL infrastructure by tightly integrating with
    • Pytorch Lightning for neural net training/testing/prediction
    • MLFlow for experiment tracking and artifact management

In doing so, DL projects become reproducible, easy to collaborate on and can benefit from general and powerful tooling.

Getting started

For more information, check our documentation, or jump straight into our getting started page, and learn how training a DL model can be as simple as:

$ serotiny train data=my_dataset model=my_model

Authors

  • Guilherme Pires @colobas
  • Ryan Spangler @prismofeverything
  • Ritvik Vasan @ritvikvasan
  • Caleb Chan @calebium
  • Theo Knijnenburg @tknijnen
  • Nick Gomez @gomeznick86

Citing

If you find serotiny useful, please cite this repository as:

Serotiny Authors (2022). Serotiny: a framework of tools to structure, configure and drive deep learning projects [Computer software]. GitHub. https://github.com/AllenCellModeling/serotiny
Free software: BSD-3-Clause

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

serotiny-0.0.0.dev202205181918.tar.gz (44.2 kB view details)

Uploaded Source

Built Distribution

serotiny-0.0.0.dev202205181918-py3-none-any.whl (67.1 kB view details)

Uploaded Python 3

File details

Details for the file serotiny-0.0.0.dev202205181918.tar.gz.

File metadata

File hashes

Hashes for serotiny-0.0.0.dev202205181918.tar.gz
Algorithm Hash digest
SHA256 f7d3c70abfd7de456ce6b2e90945dc3bcb146405b45cf8aaaf19cfbc917a3b0e
MD5 751f419a544a2a38325d6705485810f6
BLAKE2b-256 4ff8ba3f564526754398732cb05575591596bb8120d2b7524a65bb3eef4ed2f4

See more details on using hashes here.

File details

Details for the file serotiny-0.0.0.dev202205181918-py3-none-any.whl.

File metadata

File hashes

Hashes for serotiny-0.0.0.dev202205181918-py3-none-any.whl
Algorithm Hash digest
SHA256 f03561df27188525a89a6a6a4110857a9036f6be948dbdbe6dda230c0075b211
MD5 62b2d854409e4f246d5ed7dff6cfd19c
BLAKE2b-256 f7adb453037b50dc1c1178f2615d072b40ad0379d64cdef8a18fea86c4a1900a

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