Polish open-source setup and documentation#11
Open
Spbd1 wants to merge 1 commit into
Open
Conversation
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.
Motivation
Description
docs/*.md) that cover architecture, taxonomy design, taxonomy expansion protocol, annotation guidelines, evaluation protocol, API contract, dashboard user guide, limitations, and roadmap.Dockerfile,docker-compose.yml, and.env.example, plus aCHANGELOG.mdand packaged startup improvements to keep the MVP database-free.scripts/dev.pyto install deps, seed demo data, optionally import a taxonomy workbook, run backend and frontend, and open the browser; madescripts/run_backend.pyenv-configurable; addedscripts/import_taxonomy_excel.pyandscripts/export_taxonomy_excel.pyfixes; and improved frontend dev server to accept host/port from args/env.data/examples/demo_inputs.jsonlanddata/benchmarks/mini_eval_set.jsonl), updatedscripts/seed_demo_data.pyto write artifacts only when missing, and applied small engine/pack fixes (import formatting,exporterattribute assignment, pack manager/importer tidy, and a reusableuvicornstub for local startup/testing).Testing
make test(pytest): all tests passed (42 passed, 4 warnings).ruff: all checks passed after automatic fixes.make evaluate/python scripts/run_evaluation.py: benchmark executed and produced metrics (precision/recall/F1 and error buckets) to serve as regression signals.npm --prefix frontend run buildand executedpython scripts/dev.py --installto verify dependency installation and seeding; both commands completed successfully in this environment, whiledocker composecould not be exercised here because Docker is not available.Codex Task