Skip to main content

Valohai.yaml validation and parsing

Project description

valohai-yaml

Build Status Codecov License: MIT

Parses and validates valohai.yaml files.

Valohai YAML files are used to define how your machine learning project workloads and pipelines are ran on the Valohai ecosystem. Refer to Valohai Documentation to learn how to write the actual YAML files and for more in-depth usage examples.

Installation

pip install valohai-yaml

Usage

Validation

Programmatic usage:

from valohai_yaml import validate, ValidationErrors

try:
    with open('path/to/valohai.yaml') as f:
        validate(f)
except ValidationErrors as errors:
    print('oh no!')
    for err in errors:
        print(err)

Command-line usage:

valohai-yaml my_yaml.yaml
echo $?  # 1 if errors, 0 if ok

Parsing

from valohai_yaml import parse

with open('path/to/valohai.yaml') as f:
    config = parse(f)

print(config.steps['cool step'].command)

Development

pip install -e .
pip install -r requirements-lint.txt
pip install -r requirements-test.txt
pytest

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

valohai_yaml-0.26.0.tar.gz (36.0 kB view details)

Uploaded Source

Built Distribution

valohai_yaml-0.26.0-py3-none-any.whl (42.2 kB view details)

Uploaded Python 3

File details

Details for the file valohai_yaml-0.26.0.tar.gz.

File metadata

  • Download URL: valohai_yaml-0.26.0.tar.gz
  • Upload date:
  • Size: 36.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for valohai_yaml-0.26.0.tar.gz
Algorithm Hash digest
SHA256 600dd7c06e7f4bbec06c3dfb438cc9668656acead8da8eee62fcd97ee740c173
MD5 4e0ef8b729eeb76704a812f7d8515738
BLAKE2b-256 07ccf0e756450104b89ad78a8a9f369b26bc3d33c2ee0ee8781ee6c188c56eef

See more details on using hashes here.

Provenance

File details

Details for the file valohai_yaml-0.26.0-py3-none-any.whl.

File metadata

File hashes

Hashes for valohai_yaml-0.26.0-py3-none-any.whl
Algorithm Hash digest
SHA256 168519719fa9ca348d31dfa22539f87073911e0e53d553cb4d28cd9aa185e19d
MD5 1b8a845c6ff9ffc4adb305c3b2e7079f
BLAKE2b-256 2eaa66b4e29ad0c1324e1facba0a85ae21d95bf8926ad58b67824c80a7fcc09b

See more details on using hashes here.

Provenance

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