Skip to content

Update native_api doc to match the change in the get_model_info endpoint #7660

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 9, 2025
Merged

Update native_api doc to match the change in the get_model_info endpoint #7660

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
77d0315
update native_api doc to match the change in get model info
Arist12 Jun 30, 2025
ce6ea84
update doc key match and polish description
Arist12 Jun 30, 2025
b27daf6
reorder lines
Arist12 Jul 1, 2025
2d07f9b
Merge branch 'main' into update_doc_to_match_new_model_info
lifuhuang Jul 1, 2025
252f43f
Merge branch 'main' into update_doc_to_match_new_model_info
Arist12 Jul 4, 2025
b021528
Merge branch 'main' into update_doc_to_match_new_model_info
JustinTong0323 Jul 7, 2025
3937130
Merge branch 'main' into update_doc_to_match_new_model_info
lifuhuang Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/backend/native_api.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@
"\n",
"- `model_path`: The path/name of the model.\n",
"- `is_generation`: Whether the model is used as generation model or embedding model.\n",
"- `tokenizer_path`: The path/name of the tokenizer."
"- `tokenizer_path`: The path/name of the tokenizer.\n",
"- `preferred_sampling_params`: The default sampling params specified via `--preferred-sampling-params`. `None` is returned in this example as we did not explicitly configure it in server args."
]
},
{
Expand All @@ -113,6 +114,7 @@
"assert response_json[\"model_path\"] == \"qwen/qwen2.5-0.5b-instruct\"\n",
"assert response_json[\"is_generation\"] is True\n",
"assert response_json[\"tokenizer_path\"] == \"qwen/qwen2.5-0.5b-instruct\"\n",
"assert response_json[\"preferred_sampling_params\"] is None\n",
"assert response_json.keys() == {\n",
" \"model_path\",\n",
" \"is_generation\",\n",
Expand Down
Loading