sillsdev / sillsdev/silnlp

Improve the error message when a parent model folder is missing. (Translate)

Open
#108 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue needs to be revisited pipeline 3: preprocess pipeline 4: train pipeline 5: test pipeline 6: infer
Dominant language
Python
Stars
39
Forks
7
Avg merge
1d 9h
Merged PRs (30d)
5

Description

When a parent model folder is missing then the config file for that parent folder cannot be found. That leads to an error like this:

FileNotFoundError: [Errno 2] No such file or directory: '/home/david/gutenberg/MT/experiments/BT-Swahili/en-swh-8/config.yml'

I'm running a child model where the folder name begins en-swh-8 It took me a while to realise that there wasn't a problem with finding the child model config file but that the whole parent model folder was missing.

A few improvements would be:

  1. Indicate to the user that the child model folder and config file exist.
  2. If a file is missing indicate which parts of the path are missing.
  3. If we could indicate that 'line x of the config file refers to file which can't be found.' That would be very helpful.
  4. Prior to preprocessing we check that the required files exist before trying to preprocess.
    Ensure that similar checks occur (those that are required) for each part of the pipeline.

Contributor guide

No contributing guide indexed for this repository

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 reproducing the missing parent model-folder case using the child model path and config.yml example in the issue. Trace the preprocessing and other pipeline stages to identify where required-file checks occur; done should include clearer missing-path context and checks for required files throughout the relevant pipeline.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data-engineering
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.