Explicitly pass versification to machine.py APIs

Open
#1,126 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
machine-learning

Research direction

Start by reading the versification parameters and defaults in machine.py, then search the silnlp codebase for every use of those APIs. Audit each call to determine the intended versification and pass it explicitly where needed. Done means no applicable machine.py API call relies on an implicit versification default.

Written by the indexing model from the issue text.

Description

There are numerous places in the machine.py API in which versification is a parameter with a default value. This makes it easy to accidentally not pass a versification and rely on the default which can cause unexpected behavior. We should audit every use of one of these APIs in silnlp and pass an explicit versification if we're not already doing so.

Dominant language
Python
Stars
39
Forks
7
Avg merge
1d 9h
Merged PRs (30d)
5

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.

More from sillsdev/silnlp

All issues in sillsdev/silnlp

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.