Skip to content

[ENH] pipeline config #89

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

Merged
merged 5 commits into from
Mar 31, 2025
Merged

[ENH] pipeline config #89

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dbdfac8
add feature_config
jdkent Mar 27, 2025
4490e97
add config_filter logic
jdkent Mar 28, 2025
bde4e41
rename feature_config to pipeline_config
jdkent Mar 31, 2025
2e03fdc
fix wording
jdkent Mar 31, 2025
cfade05
Apply suggestions from code review
jdkent Mar 31, 2025
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
59 changes: 55 additions & 4 deletions neurostore-openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,13 +173,34 @@ paths:
parameters:
- name: feature_filter
in: query
description: Filter results by feature content using jsonpath syntax
description: >
Filter results by feature content. Format: "PipelineName[:version]:field_path=value".
Examples:
- "TestPipeline:1.0.0:groups.diagnosis=ADHD" (specific version)
- "TestPipeline:groups.diagnosis=ADHD" (any version)

Field path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=.
required: false
schema:
type: array
items:
type: string
example: 'groups.diagnosis=ADHD'
example: 'TestPipeline:1.0.0:groups.diagnosis=ADHD'
- name: pipeline_config
in: query
description: >
Filter results by pipeline config content. Format: "PipelineName[:version]:config_path=value".
Examples:
- "TestPipeline:1.0.0:preprocessing.smoothing=8" (specific version)
- "TestPipeline:model.type=linear" (any version)

Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=.
required: false
schema:
type: array
items:
type: string
example: 'TestPipeline:1.0.0:preprocessing.smoothing=8'
- name: study_id
in: query
description: Filter results by base study ID
Expand All @@ -188,6 +209,12 @@ paths:
type: array
items:
type: string
- name: version
in: query
description: Filter results by pipeline config version
required: false
schema:
type: string
responses:
'200':
description: OK
Expand Down Expand Up @@ -1065,10 +1092,34 @@ paths:
parameters:
- name: feature_filter
in: query
description: Filter studies by features
description: >
Filter studies by feature content. Format: "PipelineName[:version]:field_path=value".
Examples:
- "TestPipeline:1.0.0:predictions.age_mean>20" (specific version)
- "TestPipeline:groups.diagnosis=ADHD" (any version)

Field path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=.
required: false
schema:
type: string
type: array
items:
type: string
example: 'TestPipeline:1.0.0:predictions.age_mean>20'
- name: pipeline_config
in: query
description: >
Filter studies by pipeline config content. Format: "PipelineName[:version]:config_path=value".
Examples:
- "TestPipeline:1.0.0:settings.min_age=20" (specific version)
- "TestPipeline:model.type=linear" (any version)

Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=.
required: false
schema:
type: array
items:
type: string
example: 'TestPipeline:1.0.0:settings.min_age=20'
- name: feature_display
in: query
description: display features from pipelines
Expand Down