Skip to main content

Turns DLHub metadata into functional Python objects

Project description

# DLHub home_run

[![Build Status](https://travis-ci.org/DLHub-Argonne/home_run.svg?branch=master)](https://travis-ci.org/DLHub-Argonne/home_run)[![Coverage Status](https://coveralls.io/repos/github/DLHub-Argonne/home_run/badge.svg?branch=master)](https://coveralls.io/github/DLHub-Argonne/home_run?branch=master)

home_run is a tool used by [the Data and Learning Hub for Science](https://www.dlhub.org) internally to turn a bunch of files and a recipe into an functional Python object.

## Installation

home_run is on PyPi. Install it by calling

`bash pip install home_run `

home_run is designed to be as light-weight as possible, and has no dependencies.

## Technical Details

The key ingredients for using home_run are files describing a function that will be served by DLHub. These include a metadata file describing the servable (see [dlhub_sdk](http://github.com/dlhub-argonne/dlhub_sdk) for tools for creating these files, and [dlhub_schemas](http://github.com/dlhub-argonne/dlhub_schemas) for the schemas), and the actual files that make up the servable (e.g., a Keras hdf5 file).

Each particular type of servable has its own recipe for going from these files to a Python object. All recipes are a subclass of BaseServable, which provides the general framework for defining a servable object. Each subclass has a matching BaseMetadataModel class in dlhub_sdk. For example, the type of servable that can be described by the PythonStaticMethodModel can be run by the PythonStaticMethodServable.

## Project Support This material is based upon work supported by Laboratory Directed Research and Development (LDRD) funding from Argonne National Laboratory, provided by the Director, Office of Science, of the U.S. Department of Energy under Contract No. DE-AC02-06CH11357.

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

home_run-0.2.0.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

home_run-0.2.0-py2.py3-none-any.whl (8.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file home_run-0.2.0.tar.gz.

File metadata

  • Download URL: home_run-0.2.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3

File hashes

Hashes for home_run-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f7a75fe37c079d5fb49a140c663726731701776f1d0587275004775532f73486
MD5 2803fd889bb3761ebfdd8fd4bd012c9e
BLAKE2b-256 90f7fcda98c395bf8b70d96f59795b5ff66797079b43c256619324373bc4e204

See more details on using hashes here.

File details

Details for the file home_run-0.2.0-py2.py3-none-any.whl.

File metadata

  • Download URL: home_run-0.2.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3

File hashes

Hashes for home_run-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e952f244ebfb3ef7f91f236293fecfcb8fa4c5ceb6675e0dd93bedd4c1ccdd60
MD5 d803ab0d0401b44ffd02b36bb2f8ec8c
BLAKE2b-256 88e4c8cfc830cc039a138d7162bfded43713cab37ecf24b5150b5ed66fbb5ec2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page