microsoft / microsoft/brainsmith

Release v0.1.0 known issues

Open
#97 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
60
Forks
12
Avg merge
1d 1h
Merged PRs (30d)
2

Description

This thread is for tracking all small bugs or polish issues with the v0.1.0 release that don't warrant a dedicated issue. All issues below will be resolved in a post-release patch.

  • brainsmith registry -v lists (infer=✗) for KernelOps which are implemented as intended and (infer=✓) for FINN HWCustomOps which require an explicit infer transform specified. This presentation is confusing.
  • The effect and intended use of each build step is not well documented outside of code comments.
  • The KernelIntegrator is currently deprecated while it's updated to use the new KernelOp system. This is intended, but needs to be more clearly communicated in the CLI and docs.
  • The readme lists Python 3.11+ however only 3.11 and 3.12 are supported

Please feel free to suggest any issues to add to this list in this thread!

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

Treat the bullets as separate investigations: start with brainsmith registry -v, the build-step documentation, the KernelIntegrator deprecation messaging, and the README's Python version claim. Check each behavior and its surrounding docs or CLI output; done means the confusing output, missing explanations, deprecation communication, and inaccurate version statement are resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, cli, documentation
Issue type
Bug
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.