domino logo
Tech Ecosystem
Get started with Python
Step 0: Orient yourself to DominoStep 1: Create a projectStep 2: Configure your projectStep 3: Start a workspaceStep 4: Get your files and dataStep 5: Develop your modelStep 6: Clean up WorkspacesStep 7: Deploy your model
Get started with R
Step 0: Orient yourself to Domino (R Tutorial)Step 1: Create a projectStep 2: Configure your projectStep 3: Start a workspaceStep 4: Get your files and dataStep 5: Develop your modelStep 6: Clean up WorkspacesStep 7: Deploy your model
Domino Reference
Projects
Projects OverviewProjects PortfolioProject Goals in Domino 4+Jira Integration in DominoUpload Files to Domino using your BrowserFork and Merge ProjectsSearchSharing and CollaborationCommentsCompare File Revisions
Revert Projects and Files
Revert a FileRevert a Project
Archive a Project
Advanced Project Settings
Project DependenciesProject TagsRename a ProjectSet up your Project to Ignore FilesUpload files larger than 550MBExporting Files as a Python or R PackageTransfer Project Ownership
Domino Runs
JobsDiagnostic Statistics with dominostats.jsonNotificationsResultsRun Comparison
Advanced Options for Domino Runs
Run StatesDomino Environment VariablesEnvironment Variables for Secure Credential StorageUse Apache Airflow with Domino
Scheduled Jobs
Domino Workspaces
WorkspacesUse Visual Studio Code in Domino WorkspacesPersist RStudio PreferencesAccess Multiple Hosted Applications in one Workspace SessionUse Domino Workspaces in Safari
Spark on Domino
On-Demand Spark
On-Demand Spark OverviewValidated Spark VersionConfigure PrerequisitesWork with your ClusterManage DependenciesWork with Data
External Hadoop and Spark
Hadoop and Spark OverviewConnect to a Cloudera CDH5 cluster from DominoConnect to a Hortonworks cluster from DominoConnect to a MapR cluster from DominoConnect to an Amazon EMR cluster from DominoRun Local Spark on a Domino ExecutorUse PySpark in Jupyter WorkspacesKerberos Authentication
Customize the Domino Software Environment
Environment ManagementDomino Standard EnvironmentsInstall Packages and DependenciesAdd Workspace IDEs
Advanced Options for Domino Software Environment
Install Custom Packages in Domino with Git IntegrationAdd Custom DNS Servers to Your Domino EnvironmentConfigure a Compute Environment to User Private Cran/Conda/PyPi MirrorsScala notebooksUse TensorBoard in Jupyter WorkspacesUse MATLAB as a WorkspaceCreate a SAS Data Science Workspace Environment
Publish your Work
Publish a Model API
Model Publishing OverviewModel Invocation SettingsModel Access and CollaborationModel Deployment ConfigurationPromote Projects to ProductionExport Model Image
Publish a Web Application
Cross-Origin Security in Domino web appsApp Publishing OverviewGet Started with DashGet Started with ShinyGet Started with Flask
Advanced Web Application Settings in Domino
App Scaling and PerformanceHost HTML Pages from DominoHow to Get the Domino Username of an App Viewer
Launchers
Launchers OverviewAdvanced Launcher Editor
Assets Portfolio Overview
Connect to your Data
Domino Datasets
Datasets OverviewDatasets Best PracticesAbout domino.yamlDatasets Advanced Mode TutorialDatasets Scratch SpacesConvert Legacy Data Sets to Domino Datasets
Data Sources OverviewConnect to Data Sources
Git and Domino
Git Repositories in DominoWork From a Commit ID in Git
Work with Data Best Practices
Work with Big Data in DominoWork with Lots of FilesMove Data Over a Network
Advanced User Configuration Settings
User API KeysOrganizations Overview
Use the Domino Command Line Interface (CLI)
Install the Domino Command Line (CLI)Domino CLI ReferenceDownload Files with the CLIForce-Restore a Local ProjectMove a Project Between Domino DeploymentsUse the Domino CLI Behind a Proxy
Browser Support
Get Help with Domino
Additional ResourcesGet Domino VersionContact Domino Technical SupportSupport Bundles
domino logo
About Domino
Domino Data LabKnowledge BaseData Science BlogTraining
User Guide
>
Domino Reference
>
Connect to your Data
>
Domino Datasets
>
About domino.yaml

About domino.yaml

domino.yaml is a file that defines Dataset configurations. It isn’t there by default, and should be created at the root of your project.

A Dataset configuration controls:

  • Existing Dataset Snapshots and how those Snapshots are mounted for input.

  • New directories that can become Snapshots and how those directories are mounted for output.

Schema

The domino.yaml file respects the following schema. Spaces matter.

datasetConfigurations: # contains array of configurations
 - name: string # identifier for this configuration
   inputs: # contains array of datasets to mount for input
     - path: string # path appended to /domino/datasets
       dataset: string # name of the dataset to mount as input
   outputs: # contains array of datasets to mount for input
     - path: string # path appended to /domino/datasets
       dataset: string # name of the dataset to mount for output

Valid fields in the YAML object are:

  • datasetConfigurations

    This is a required field. It must be the first very first field on the first line. Only one of these fields can exist in the YAML file. This will contain an array of individual Dataset configurations.

  • name

    Identifier for a specific configuration.

  • path

    Desired mount path for Dataset Snapshot or new Snapshot directory.

  • dataset

    Name of dataset. If configured as input, the latest Snapshot of the Dataset will be mounted by default. A different tagged Snapshot can be specified using a colon, like {dataset-name}:{tag}. For example: iris:test

  • inputs

    Contains array of one or more [path, dataset] specifications to be mounted for input.

  • outputs

    Contains array of one or more [path, dataset] specifications.

Error Handling

If you attempt to use an invalid domino.yaml, you may see one of these categories of error.

  • Invalid field that Domino does not recognize in a particular position

    The error indicates the field found and shows valid field options for that position.

    Example

    Found invalid field in domino.yaml: “output”.
    Valid field options: “inputs”, “outputs”, “name”
  • Valid field that Domino recognizes in a particular position, but there is an error.

    An example of this is two outputs fields in one name block.

    Example

    There is an error in domino.yaml encountered while processing field “outputs”.
    Please check all your “outputs” fields.
  • Valid field that Domino recognizes in an incorrect position.

    An example of this is a valid field with the wrong indentation.

    Example

    There is a formatting error in domino.yaml encountered while processing field
    “dataset”. Please check all your “dataset” fields.
  • Syntax error

    An example of this is a missing quote. In some cases, we can identify the region the error occurs.

    Example

    There is a formatting error in domino.yaml in the block near 12.
  • Catch all

    We are having trouble parsing domino.yaml.
    Please see the support article linked above. If you still cannot identify
    the problem, please email support@dominodatalab.com about your problem and include your domino.yaml.
Domino Data LabKnowledge BaseData Science BlogTraining
Copyright © 2022 Domino Data Lab. All rights reserved.