Updated create_index #1571
Merged
Updated create_index #1571
Conversation
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
JinHai-CN
reviewed
Aug 1, 2024
JinHai-CN
reviewed
Aug 1, 2024
JinHai-CN
reviewed
Aug 1, 2024
| - `"ip"`: Inner product. | ||
| - `"l2"`: Euclidean distance. | ||
| - `"cosine"`: Cosine similarity. | ||
| - Parameter settings for a secondary index: |
JinHai-CN
reviewed
Aug 1, 2024
JinHai-CN
reviewed
Aug 1, 2024
JinHai-CN
reviewed
Aug 1, 2024
JinHai-CN
reviewed
Aug 1, 2024
JinHai-CN
reviewed
Aug 1, 2024
JinHai-CN
reviewed
Aug 1, 2024
| - `"pq_subspace_num"`: *Required* - Recommended: "32". | ||
| - `"pq_subspace_bits"`: *Required* - Recommended: "8". | ||
| - Parameter settings for a full text index: | ||
| - `"ANALYZER"`: *Optional* - Defaults to `"standard"` |
There was a problem hiding this comment.
All parameters should be case-insensitive.
There was a problem hiding this comment.
These parameters are case-sensitive. @JinHai-CN
JinHai-CN
reviewed
Aug 1, 2024
| The name of the column to build index on. Must not be empty. | ||
| - **index_type**: `IndexType`, *Required* | ||
| Index type. You may want to import `infinity.index` to set `IndexType`: `from infinity.index import IndexType` | ||
| - `Hnsw`: A HNSW index. |
JinHai-CN
reviewed
Aug 1, 2024
JinHai-CN
reviewed
Aug 1, 2024
JinHai-CN
reviewed
Aug 1, 2024
JinHai-CN
reviewed
Aug 1, 2024
JinHai-CN
reviewed
Aug 2, 2024
| - **index_param_list**: `list[InitParameter(str, str)]` | ||
| A list of `InitParameter` objects specifying parameter settings for the chosen index type. Each object handles one parameter setting. To set a specific index parameter, pass the parameter name and its corresponding value as two separate strings to the `InitParameter` object: | ||
| - Parameter settings for an HNSW index: | ||
| - `"M"`: *Optional* - Defaults to`"16"`. |
JinHai-CN
reviewed
Aug 2, 2024
|
|
||
| ### Returns | ||
|
|
||
| - Success: An index object. |
There was a problem hiding this comment.
Return value, should have error message
JinHai-CN
approved these changes
Aug 2, 2024
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 problem does this PR solve?
Issue link:#1490
Type of change