much improved doc strings for client #290
Merged
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
HammadB
reviewed
Apr 4, 2023
| The newly created collection | ||
|
|
||
| Raises: | ||
| ValueError: If the collection already exists and get_or_create is False |
There was a problem hiding this comment.
Isn't there also some error if the collection doesn't follow naming guidelines?
HammadB
reviewed
Apr 4, 2023
| The collection | ||
|
|
||
| Examples: | ||
| >>> client.get_or_create_collection("my_collection") |
HammadB
reviewed
Apr 4, 2023
| None | ||
|
|
||
| Raises: | ||
| ValueError: If you don't provide either embeddings or documents |
There was a problem hiding this comment.
There are a bunch of validation errors that could also be thrown? Do we want to surface those here?
HammadB
reviewed
Apr 4, 2023
chromadb/api/models/Collection.py
Outdated
| GetResult: A GetResult object containing the results. | ||
|
|
||
| Raises: | ||
| ValueError: If you provide both ids and a where filter |
There was a problem hiding this comment.
Do we really do this? I think we support both.
HammadB
approved these changes
Apr 4, 2023
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.
Improved docstrings for chroma-core/docs#28