Repository navigation
docs: refresh README ML status, add data licences, drop stale screenshots - #22
Merged
Merged
Conversation
…hots Remove stale root app screenshots, correct the Python version claims that came from a dangling ml/.venv, drop the redundant ml/.venv gitignore entry, replace the gate-only detector claim with the current ML status, and add data and third-party model licence notes (Ultralytics AGPL-3.0).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✅ Deploy Preview for digisim canceled.
|
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Intent
DigiSim is a neglected project. Pull up the latest changes in Linux. It is high time to start training the model for it. I have not been able to provide the data. Figure out, get the data, train a model, make improvements and fix that. Do not come to me until you absolutely need me.
Context: the scout report found that the only trained detector uses 12 gate-era classes and detects nothing on the transistor-first schematics the app now uses, that the transistor-level training data does not exist yet, and that the wire/net tracing assumes left-to-right gates. The work was split into tasks T1-T11; this change is T11 (repo hygiene): delete stale root screenshots, fix ml/.venv leftovers, update the README ML section so it no longer claims gate-only detection, note that Ultralytics is AGPL-3.0, and add a data licences section.
What Changed
1st.jpg,2nd.jpg,3rd.jpg,4th.jpg) and dropped the leftoverml/.venv/line from.gitignore(the generic.venv/rule already covers it).LICENSEfile exists yet, instead of claiming MIT.Risk Assessment
✅ Low: Docs-only edits plus deletion of four unreferenced root screenshots; README claims (46 images/6 classes, zip and 51 Sampleimages tracked, Python >=3.11 with Docker 3.12, pipeline file names, AGPL note, MIT-intended wording) check out against the tree, and the earlier review decisions were applied.
Testing
The change has no runnable product surface (docs, a .gitignore line and deleted images). I confirmed README claims against the repo with read-only checks: ignore behaviour for ml/.venv, tracked file counts, data licence metadata, referenced paths, Python version statements and the missing LICENSE file. These were repository checks, not live runs of the product. I did not run the test suite, produce screenshots, or run the app.
ml/.venv/line from .gitignore still ignores ml/.venvPipeline
Updates from git push no-mistakes
✅ **intent** - passed
✅ No issues found.
✅ **Rebase** - passed
✅ No issues found.
✅ **Review** - passed
✅ No issues found.
ml/.venv/line from .gitignore still ignores ml/.venv, README data-licence and committed-data statements match what is trackedml/.venv/line from .gitignore still ignores ml/.venvgit check-ignore -v ml/.venv/xshows ml/.venv is still ignored by the general.venv/rule after the .gitignore line was removed, andgit ls-files ml/.venvreturns nothing (repository check, not live)ls *.jpgat the root finds nothing, so the stale screenshots are gone (repository check)Counted tracked data: Sampleimages/ has 51 tracked files,My First Project.yolov8/has 46 images, andMy First Project.yolov8.zipis present, matching the README (repository check)My First Project.yolov8/data.yamllists 6 gate classes with CC BY 4.0, workspace cirzer, project my-first-project-yz9wf; the export README says it was exported on June 15, 2026 (repository check)Every path the README references exists: the four pipeline stage files, agent_docs/ml-pipeline.md, ml/train.py, ml/evaluate.py, backend/.env.example (which sets MODEL_WEIGHTS_PATH), docs/deploy-vercel-render.md and backend/data_genPython 3.11+ and 3.12 claims matchrequires-python = ">=3.11"in backend/pyproject.toml and ml/pyproject.toml, andFROM python:3.12-slimin backend/DockerfileNo LICENSE file exists, matching the reworded README ('intended MIT, no LICENSE file yet') per the recorded review decisionsThe detector's 12-class vocabulary claim was not checked against a config; I only confirmed a JUNCTION class exists in the pipeline code✅ **Document** - passed
✅ No issues found.
✅ **Lint** - passed
✅ No issues found.
✅ **Push** - passed
✅ No issues found.