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.

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

Pipestat messaging update suggestions #209

Open
6 tasks
nsheff opened this issue Oct 10, 2024 · 1 comment
Open
6 tasks

Pipestat messaging update suggestions #209

nsheff opened this issue Oct 10, 2024 · 1 comment
Labels

Comments

@nsheff
Copy link
Contributor

nsheff commented Oct 10, 2024

There's some confusing language I think we should clean up.

here's a vanilla looper check:

 looper check
Looper version: 2.0.0a2
Command: check
Using looper config (.looper.yaml).
No config key in Project, or reading project from dict
Traceback (most recent call last):
  File "/home/ns5bc/.local/bin/looper", line 8, in <module>
    sys.exit(main_cli())
             ^^^^^^^^^^
  File "/home/ns5bc/.local/lib/python3.11/site-packages/looper/cli_pydantic.py", line 357, in main_cli
    main()
  File "/home/ns5bc/.local/lib/python3.11/site-packages/looper/cli_pydantic.py", line 353, in main
    return run_looper(args, parser, test_args=test_args)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/ns5bc/.local/lib/python3.11/site-packages/looper/cli_pydantic.py", line 319, in run_looper
    raise PipestatConfigurationException("check")

Then I added this to the looper config:

pipestat:
  results_file_path: results.yaml

And now it says:

looper check
Looper version: 2.0.0a2
Command: check
Using looper config (.looper.yaml).
No config key in Project, or reading project from dict
Pipeline name mismatch detected. Pipeline interface: PEPATAC  Output schema: None  Defaulting to pipeline_interface value.
Initializing results file '/project/shefflab/brickyard/results_pipeline/tlgl_atac/PEPATAC/results.yaml'
File does not exist, but create_file is true. Creating...
     'PEPATAC' pipeline status summary     
┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃  Status   ┃    Jobs count/total jobs    ┃
┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
└───────────┴─────────────────────────────┘

Some things here confusing me:

  • Why does it say "No config key in Project, or reading project from dict". Can this be reworded? I'm not getting anything useful from this message.
  • Looper documentation/tutorial does not actually specify how to configure: "Pipestat must be configured for command check". I think it's lumped in with description of results
  • Is the pipeline name thing important? Can we explain what this means somewhere: "Pipeline name mismatch detected. Pipeline interface: PEPATAC Output schema: None Defaulting to pipeline_interface value."
  • To what is "File does not exist, but create_file is true. Creating..." referring? To "results.yaml file"?
  • Why is looper check creating results.yaml? Shouldn't that be at looper run?
  • This is not finding the jobs. I do not know how to configure pipestat to actually find the jobs and check/report on them correctly. This is using PEPATAC and it is creating _failed flags.
@nsheff
Copy link
Contributor Author

nsheff commented Oct 10, 2024

I guess the biggest issue here is this: I cannot figure out how to configure pipestat such that looper check works, and there appears to be little documentation on that. it just says "use looper check", but that doesn't work.

Do you have to configure it before running the pipeline? I ran the pipeline before configuring pipestat. It still created flag files. now how do I check them?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant