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

Uploaded Source

Built Distribution

valohai_yaml-0.33.0-py3-none-any.whl (50.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for valohai_yaml-0.33.0.tar.gz
Algorithm Hash digest
SHA256 f730af3eda8307e0e28cf0caaa537d1cf433ef34f20dc7735b8d09397f8b623f
MD5 3557ec650de4e662daa56ae194df162b
BLAKE2b-256 6e7325c483cf05e41388f5dc1c832ffb8662c845f6e8882de4e48e3777420d1a

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for valohai_yaml-0.33.0-py3-none-any.whl
Algorithm Hash digest
SHA256 198ed413b08d7e96d3d79066c88db181d83cdfdffa419342f56a5b28f884ff71
MD5 82cf189d3ba23a229c12ee2e7860b71d
BLAKE2b-256 400318739a59380f9bcfd855e4a6d90f48298273ee693cb85b9aec3cff76076c

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