Skip to content

Fix docs building #223

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 2 commits into from
Aug 25, 2023
Merged

Fix docs building #223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca97a69
fix docs building
phil-scale Aug 25, 2023
b43dc60
fix
phil-scale Aug 25, 2023
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: 2 additions & 2 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,14 @@ repos:
hooks:
- id: mypy
name: mypy-clients-python
entry: mypy --config-file clients/python/mypy.ini clients/python
entry: mypy --config-file clients/python/mypy.ini
language: system
- repo: https://github.com/pre-commit/mirrors-mypy
rev: 'v1.3.0' # Make sure this matches the version in requirements-dev.txt!
hooks:
- id: mypy
name: mypy-server
entry: mypy --config-file model-engine/mypy.ini model-engine
entry: mypy --config-file model-engine/mypy.ini
language: system
- repo: local
hooks:
Expand Down
52 changes: 52 additions & 0 deletions docs/api/data_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,37 @@
- num_completion_tokens

::: llmengine.CompletionSyncResponse
selection:
Copy link
Contributor

@yunfeng-scale yunfeng-scale Aug 25, 2023

Choose a reason for hiding this comment

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

hmm, do we must list these one by one?

Copy link
Contributor Author

@phil-scale phil-scale Aug 25, 2023

Choose a reason for hiding this comment

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

There's a configuration in mkdocs.yml that allows members to be listed automatically, but the trade off is that we have no control over the order of the members.

members:
- request_id
- output

::: llmengine.CompletionStreamResponse
selection:
members:
- request_id
- output

::: llmengine.CreateFineTuneResponse
selection:
members:
- id

::: llmengine.GetFineTuneResponse
selection:
members:
- id
- fine_tuned_model

::: llmengine.ListFineTunesResponse
selection:
members:
- jobs

::: llmengine.CancelFineTuneResponse
selection:
members:
- success

::: llmengine.GetLLMEndpointResponse
selection:
Expand All @@ -42,19 +63,50 @@
- spec

::: llmengine.ListLLMEndpointsResponse
selection:
members:
- model_endpoints

::: llmengine.DeleteLLMEndpointResponse
selection:
members:
- deleted

::: llmengine.ModelDownloadRequest
selection:
members:
- model_name
- download_format

::: llmengine.ModelDownloadResponse
selection:
members:
- urls

::: llmengine.UploadFileResponse
selection:
members:
- id

::: llmengine.GetFileResponse
selection:
members:
- id
- filename
- size

::: llmengine.GetFileContentResponse
selection:
members:
- id
- content

::: llmengine.ListFilesResponse
selection:
members:
- files

::: llmengine.DeleteFileResponse
selection:
members:
- deleted