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

Uploaded Source

Built Distribution

valohai_yaml-0.36.0-py3-none-any.whl (52.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: valohai_yaml-0.36.0.tar.gz
  • Upload date:
  • Size: 47.3 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.36.0.tar.gz
Algorithm Hash digest
SHA256 f46a0af6a480b5dd5573ac8323564318839c5a317c7c98a641d156ae7bb7876d
MD5 6fba9ca1f4d06bff57a7f3d84ce53005
BLAKE2b-256 c17bb3222cd8d1dff5c8bf7c5e62f589f04dba6c98d6ccf79d0708a74256fcb6

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for valohai_yaml-0.36.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f6f298a17c0290901098f7af19b6cae29ecea21b66643e01b09805d58998c78a
MD5 2f7266de17a31bade953c72157e50953
BLAKE2b-256 c42b2f6ce528f9c613919497e52dfbc41fa00153fbdfd9daa8b27af64a79ebcf

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