Skip to content

ENH: Update parameters reference - #181

Merged
codingl2k1 merged 1 commit into
mainfrom
doc/update_doc
Aug 22, 2026
Merged

ENH: Update parameters reference#181
codingl2k1 merged 1 commit into
mainfrom
doc/update_doc

Conversation

@codingl2k1

Copy link
Copy Markdown

No description provided.

@codingl2k1
codingl2k1 merged commit e51f2b4 into main Aug 22, 2026
1 check passed

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds the mmproj_device parameter to the params_reference.md documentation. The review feedback suggests organizing this parameter under the 'Multimodal' section and updating its documented default value from nullptr to "" to avoid confusion for Python users, both of which require updates to the documentation generation script.

Comment thread params_reference.md
| `load_mode` | llama_load_mode | `LLAMA_LOAD_MODE_AUTO` | R/W | how to load the model. |
| `mcp_servers_config` | str | `` | R/W | path to JSON file with MCP server definitions |
| `mcp_servers_json` | str | `` | R/W | inline JSON with MCP server definitions |
| `mmproj_device` | str | `nullptr` | R/W | GPU device for the multimodal projector (empty means auto, 'none' disables offload). |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better organization and discoverability, the mmproj_device parameter should be documented under the 'Multimodal' section along with other related parameters like mmproj and mmproj_use_gpu.

To fix this, please add 'mmproj_device' to the Multimodal group list within COMMON_PARAMS_GROUPS in scripts/generate_params_doc.py and regenerate this documentation file.

Comment thread params_reference.md
| `load_mode` | llama_load_mode | `LLAMA_LOAD_MODE_AUTO` | R/W | how to load the model. |
| `mcp_servers_config` | str | `` | R/W | path to JSON file with MCP server definitions |
| `mcp_servers_json` | str | `` | R/W | inline JSON with MCP server definitions |
| `mmproj_device` | str | `nullptr` | R/W | GPU device for the multimodal projector (empty means auto, 'none' disables offload). |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The default value for mmproj_device is documented as nullptr, which is the C++ default. However, the Python wrapper translates this to an empty string ("") for the 'auto' behavior. To avoid confusion for Python users, the documentation should reflect the effective default value, which is "".

This likely requires an adjustment in scripts/generate_params_doc.py to handle this case, or a special case for this parameter's default value.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant