MLBazaar / MLBazaar/MLPrimitives

Define formal primitives specification

Open
#42 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

internal improvement Pending Review
Dominant language
Python
Stars
70
Forks
37
PR merge metrics
No merged PRs in 30d

Description

The JSON primitives files can be fairly large and complicated and susceptible to misspecification. Implement a formal specification for the JSON files using json schema

  • define the specification in JSON schema (I suggest using the jsonschema package from PyPI)

  • implement a validator to validate a JSON primitive file:

      from mlprimitives.validation import validate
      primitive = load_primitive_from_json()  # or similar
      primitive = validate(primitive)
    

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 reviewing the existing JSON primitives files and the proposed validation entry point, mlprimitives.validation.validate. Define the JSON Schema for the primitive structure and determine how a loaded primitive should be validated using the jsonschema package. Done means the schema exists, validation is exposed through the stated interface, and primitive files can be checked consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
machine-learning
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.