Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix quickstart example #154

Merged
merged 3 commits into from
Feb 20, 2024
Merged

Fix quickstart example #154

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce1560c
Fix `output_schema.yaml` in quickstart example
simeoncarstens Feb 13, 2024
3b7d4b7
Syntax highlighting for quickstart `output_schema.yaml`
simeoncarstens Feb 13, 2024
017101c
Update docs/README.md
donaldcampbelljr Feb 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions docs/README.md
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yes. I see the problem. We also began moving towards using JSON schema for the output schemas (while still supporting the old style). I suggest we go ahead and change this readme to have that format:

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"

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
Loading