Fix README: structure, typos, and incorrect filenames#305
Merged
Conversation
Co-authored-by: ekosman <10260165+ekosman@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README documentation for clarity and details
Fix README: structure, typos, and incorrect filenames
Feb 21, 2026
ekosman
approved these changes
Feb 21, 2026
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.
The README had structural inconsistencies in the TOC, several typos, incorrect annotation filenames, and Windows-style path separators in HTML links.
Changes
Feature Extractor Weights(both in TOC and body) — they were incorrectly nested underDocker installationTrain_annotations.txt→Train_Annotation.txt,Test_annotations.txt→Test_Annotation.txt(match actual repo files)exps\...\epoch_*.pthrefs💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.