Skip to content

Commit

Permalink
Merge pull request #154 from simeoncarstens/tweag/fix-quickstart
Browse files Browse the repository at this point in the history
Fix quickstart example
  • Loading branch information
donaldcampbelljr authored Feb 20, 2024
2 parents e8a0670 + 017101c commit d730ea0
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,18 @@ export PIPESTAT_RECORD_IDENTIFIER=my_record
export PIPESTAT_RESULTS_FILE=results_file.yaml
```
Note: When setting environment variables as in the above example, you will need to provide an output_schema.yaml file in your current working directory with the following example data:
```
result_name:
type: string
description: "Result Name"
```
```yaml
title: An example Pipestat output schema
description: A pipeline that uses pipestat to report sample and project level results.
type: object
properties:
pipeline_name: "default_pipeline_name"
samples:
type: object
properties:
result_name:
type: string
description: "ResultName"

## Pipeline results reporting and retrieval
### For these examples below, it is assumed that the proper environment variables (see above) have been set.
Expand Down

0 comments on commit d730ea0

Please sign in to comment.