Update Chains Docs. #1282
Merged
Update Chains Docs. #1282
Conversation
This file contains 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
tyranitar
approved these changes
Dec 12, 2024
| @@ -85,12 +86,11 @@ an access token for downloading model weights). | |||
| | Name | Type | Description | | |||
| |------|------|-------------| | |||
| | `data_dir` | *Path\|None* | The directory where the chainlet can store and access data, e.g. for downloading model weights. | | |||
| | `user_config` | ** | User-defined configuration for the chainlet. | | |||
| | `chainlet_to_service` | *Mapping[str,[ServiceDescriptor](#truss_chains.ServiceDescriptor* | A mapping from chainlet names to service descriptors. This is used create RPCs sessions to dependency chainlets. It contains only the chainlet services that are dependencies of the current chainlet. | | |||
| | `chainlet_to_service` | *Mapping[str,[DeployedServiceDescriptor](#truss_chains.DeployedServiceDescriptor* | A mapping from chainlet names to service descriptors. This is used create RPCs sessions to dependency chainlets. It contains only the chainlet services that are dependencies of the current chainlet. | | |||
There was a problem hiding this comment.
Are the brackets for Mapping[str,[DeployedServiceDescriptor](#truss_chains.DeployedServiceDescriptor supposed to be imbalanced? I noticed a few other instances of this.
There was a problem hiding this comment.
There must be a bug somewhere here: https://github.com/basetenlabs/truss/blob/main/docs/chains/doc_gen/mdx_adapter.py#L30
I couldn't track it down without spending too much time on it. I'll just fix it manually for now.
| @@ -85,12 +86,11 @@ an access token for downloading model weights). | |||
| | Name | Type | Description | | |||
| |------|------|-------------| | |||
| | `data_dir` | *Path\|None* | The directory where the chainlet can store and access data, e.g. for downloading model weights. | | |||
| | `user_config` | ** | User-defined configuration for the chainlet. | | |||
| | `chainlet_to_service` | *Mapping[str,[ServiceDescriptor](#truss_chains.ServiceDescriptor* | A mapping from chainlet names to service descriptors. This is used create RPCs sessions to dependency chainlets. It contains only the chainlet services that are dependencies of the current chainlet. | | |||
| | `chainlet_to_service` | *Mapping[str,[DeployedServiceDescriptor](#truss_chains.DeployedServiceDescriptor* | A mapping from chainlet names to service descriptors. This is used create RPCs sessions to dependency chainlets. It contains only the chainlet services that are dependencies of the current chainlet. | | |||
There was a problem hiding this comment.
Suggested change
| | `chainlet_to_service` | *Mapping[str,[DeployedServiceDescriptor](#truss_chains.DeployedServiceDescriptor* | A mapping from chainlet names to service descriptors. This is used create RPCs sessions to dependency chainlets. It contains only the chainlet services that are dependencies of the current chainlet. | | |
| | `chainlet_to_service` | *Mapping[str,[DeployedServiceDescriptor](#truss_chains.DeployedServiceDescriptor* | A mapping from chainlet names to service descriptors. This is used to create RPC sessions to dependency chainlets. It contains only the chainlet services that are dependencies of the current chainlet. | |
squidarth
approved these changes
Dec 12, 2024
marius-baseten
force-pushed
the
marius/docs
branch
from
886d0b9 to
154473a
Compare
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
NOTE: only changes in
docs/chains/doc_gen/API-reference.mdxare going to be published.💻 How
🔬 Testing