Repository navigation
Describe every way to use LocalDeploy, not only the OpenAI-compatible API - #101
Merged
Merged
Conversation
… API The README, the API guide, the package description and the agent notes named the web UI and the OpenAI-compatible API. The code also ships a native API, a control API of about 50 endpoints, the decision API, deployment manifests, and generated setups for eight clients. Add a Ways to use it table, a Where it fits section, and the measured decision-model result, and list all four API families at the top of the API guide.
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.
What changed
The README,
docs/API_OPTIONS.md,AGENTS.mdand the package description described LocalDeploy as a web UI plus an OpenAI-compatible API. The code ships more than that, and a visitor could not tell./chat,/vision,/estimate,/benchmark), the control API (about 50 endpoints, reference at/docs), the decision API, generated client setups (Open WebUI, AnythingLLM, Continue, Cline, curl, Python, JavaScript, Docker Compose), deployment manifests, and the terminal helpers. New Where it fits section. The decision-model paragraph now carries the measured result and links to the raw runs.docs/API_OPTIONS.md: opens with a table of the four API families instead of "native or OpenAI-compatible".AGENTS.mdandpyproject.toml: the one-line description names the same surface.Every claim was checked against the routes in
localdeploy/server.pyandlocaldeploy/control/. The decision-model numbers are copied frombenchmarks/decision-routing/README.md. llmfit and other tools are deliberately not named.Verification
pytest tests/test_documentation.py tests/test_packaging.py: 10 passed, 3 skipped (Unix launcher tests, on Windows)git diff --check: clean; no em dashes in the changed filesuv buildandtwine check: the sdist passes with the new description and READMENot run: the full suite (no Python behavior changed).
Notes
Merge before the 0.7.0 release so the PyPI page shows the new README.