docs(config): align example precision and format with spec table#178
docs(config): align example precision and format with spec table#178rishi-jat wants to merge 1 commit intomodelpack:mainfrom
Conversation
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the accuracy and internal consistency of the documentation. It rectifies discrepancies in an example configuration by aligning its values with the established specification, thereby improving clarity and reducing potential confusion for users referencing the documentation. Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Pull request overview
Updates the model artifact configuration documentation example to match the supported format and precision values defined in the same document, keeping the config spec internally consistent.
Changes:
- Changed example
config.formatfrompytorchtopt - Changed example
config.precisionfromfp16tofloat16
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Code Review
This pull request corrects the example in docs/config.md to align with the specification table in the same file. My review points out that this change creates inconsistencies with code comments in a Go source file and also highlights an opportunity to strengthen the JSON schema. Addressing these points would improve the overall consistency and robustness of the project.
| "format": "pt", | ||
| "paramSize": "8b", | ||
| "precision": "fp16", | ||
| "precision": "float16", |
There was a problem hiding this comment.
While these changes align the example with the specification, they also highlight inconsistencies in other parts of the repository that should be addressed for overall project consistency.
- Go source code: The comments in
specs-go/v1/config.goare now out of sync with this documentation.- The comment for
ModelConfig.Format(line 31) still mentionspytorch. - The comment for
ModelConfig.Precision(line 37) still mentionsfp16.
- The comment for
- JSON Schema: The schema in
schema/config-schema.jsoncould be strengthened to enforce allowed values. For example, theformatproperty could use anenumto list the valid formats ("onnx","safetensors","gguf","pt"). This would help prevent future inconsistencies.
Please consider addressing these related inconsistencies in this PR or a follow-up to improve overall project quality.
|
/cc @chlins |
The example in docs/config.md used values (fp16, pytorch) that did not match the documented precision and format values in the specification table.
This PR updates the example to use float16 and pt to ensure internal consistency.