HumanBrainProject / HumanBrainProject/hbp-validation-framework

Review code to ensure 'version' is not necessarily unique

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

Nobody has claimed this yet.

REST API v2
Dominant language
Python
Stars
5
Forks
12
PR merge metrics
No merged PRs in 30d

Description

@apdavison proposed that:
model version does not have to be unique, but rather the combination of version and parameters should be considered unique.

You can have two model instances with the same code version but different parameters.

I had always worked with the presumption that version for instances was similar to alias for models/tests (a human readable unique identifier, as opposed to the UUID). All my implementations were with this understanding, and I believe even the unit tests were written to test only this aspect. So parts of the codebase could be faulty for this scenario.

The code for the web apps and unit tests would need to be reviewed and updated, where required, to handle this.

To be decided: if the same rule should apply for test instances

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 reviewing the issue's proposal and tracing how model version and parameters are handled across the web apps and unit tests; no specific files are named. Resolve whether the same uniqueness rule applies to test instances before changing behavior. Done means the relevant code and tests consistently handle identical versions with different parameters.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend, testing
Issue type
Refactor
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.