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

# setup development dependencies
make dev

# run linting and type checks
make lint

# run tests
make test

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.35.0.tar.gz (46.5 kB view details)

Uploaded Source

Built Distribution

valohai_yaml-0.35.0-py3-none-any.whl (52.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for valohai_yaml-0.35.0.tar.gz
Algorithm Hash digest
SHA256 64c310fb0c36e0944c4b0bcb869d4cc22f3a5cf12c088a874d9e99e419fc0261
MD5 a2af28b3189a34d2a8a2aa849614b4f3
BLAKE2b-256 b04522dafc86c1ebf8dec06a78c4ff54b96f3bdca7a3b9d3ec40752e4d25112d

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for valohai_yaml-0.35.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5553d4224ed2fae2266138e88b4fee5b1d3fd092b2d3d406ea0d1a9761e5dfd8
MD5 0ab4e4e0d306b848dbb7d7c723634382
BLAKE2b-256 a53a63ff89b630ea6bea762c9586dcb1bc0be5b6e4457b8863bc4ace50517083

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