mlcommons / mlcommons/tiny

User guide for submitter/internally implemented was never published

Open
#100 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
479
Forks
116
PR merge metrics
No merged PRs in 30d

Description

Hi Guys,
Way back last year I wrote a large section in this document that explained the test harness. This was never published and the comments were removed when the code was re-written from the EEMBC layout to the new "submitter/internally implemented" structure. I've seen some bugs and questions related to lack of documentation, and I think would help to add this as a user-guide and update it to match the new code structure Nat implemented.

Peter

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 linked Google document and the current submitter/internally implemented structure. Compare its test-harness guidance with the newer structure that replaced the EEMBC layout and the changes attributed to Nat. Done means an updated user guide is published and reflects the current code organization.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.