Medical-Event-Data-Standard / Medical-Event-Data-Standard/MEDS-DEV

meds-dev-evaluation documentation clarity

Open Beginner friendly
#253 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
43
Forks
10
PR merge metrics
No merged PRs in 30d

Description

It should be made explicitly clear in the meds-dev-evaluation cli documentation that using the predictions_dir command line argument can ONLY be used when trying to evaluate over predictions sharded across multiple subfolders within the passed path. It should also be made explicit that if you are trying to run evaluation over only a single predictions.parquet to use predictions_path instead.

While this becomes clear when running meds-dev-evaluation -- help, meds-dev should make this clear in the documentation. For example:

# Use this when predictions are sharded in subfolders
meds-dev-evaluation predictions_dir=path_with_subfolders output_dir=out_path

# Use this when you have a single Parquet file
meds-dev-evaluation predictions_path=path_to_predictions.parquet output_dir=out_path

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the CLI documentation for meds-dev-evaluation and compare it with the guidance shown by meds-dev-evaluation --help. Update the documentation to distinguish predictions_dir for predictions sharded across subfolders from predictions_path for one predictions.parquet, including the example commands; done when this distinction is explicit.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.