docs: fix Quick Start example and config field names#33
Merged
MadhurKumar004 merged 2 commits intopointblank-club:mainfrom Feb 1, 2026
Merged
Conversation
- Removed reference to non-existent examples/quick_start.ef file - Fixed config field names from 'model_path'/'output_path' to 'model'/'output' to match validator requirements - Added clarification to create my_config.ef in project root directory The README referenced examples/quick_start.ef which doesn't exist and would be ignored by .gitignore rules. Also, the example configs used 'model_path' and 'output_path' but the validator expects 'model' and 'output', causing validation failures for users following the docs. Tested and verified config now loads successfully.
| This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. | ||
|
|
||
| ## Security Notes | ||
| This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. |
Collaborator
There was a problem hiding this comment.
What did you change in this line?
Contributor
Author
There was a problem hiding this comment.
Ah, I see - there was a blank line there that I removed by mistake. I'll add it back.
| ### 4. Create Your Own Config | ||
|
|
||
| Create a file `my_config.ef`: | ||
| Create a file `my_config.ef` in the project root directory: |
Collaborator
There was a problem hiding this comment.
Add a comment line like : note: reqiures a .h5/.onnx/.keras model file
Contributor
Author
There was a problem hiding this comment.
Makes sense! I'll add that note now.
Added clarification that users need an actual .tflite/.h5/.onnx/.keras model file, not just the placeholder path.
Collaborator
|
LGTM |
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
2 participants
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 referenced examples/quick_start.ef which doesn't exist and would be ignored by .gitignore rules. Also, the example configs used 'model_path' and 'output_path' but the validator expects 'model' and 'output', causing validation failures for users following the docs.
Tested and verified config now loads successfully.