Skip to content
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

Jump to bottom

docs: clarification/typo in tutorial #4810

Merged
merged 3 commits into from
May 13, 2024
Merged

docs: clarification/typo in tutorial #4810

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
411f5a8
docs: user clarification and typo
sdiazlor May 8, 2024
f52e4cb
docs: fix vectors
sdiazlor May 8, 2024
5f73cd8
Update add-vectors-004.ipynb
sdiazlor May 8, 2024
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
2 changes: 1 addition & 1 deletion docs/_source/getting_started/installation/configurations/user_management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ import argilla as rg

rg.init(api_url="<ARGILLA_API_URL>", api_key="<ARGILLA_API_KEY>")

user = rg.User.from_id("new-user")
user = rg.User.from_id("00000000-0000-0000-0000-000000000000")
```

### Assign a `User` to a `Workspace`
Expand Down
4 changes: 2 additions & 2 deletions docs/_source/getting_started/installation/configurations/workspace_management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,8 @@ workspace = rg.Workspace.from_name("new-workspace")
users = workspace.users
for user in users:
...
workspace.add_user("<USER_ID>")
workspace.delete_user("<USER_ID>")
workspace.add_user(user.id)
workspace.delete_user(user.id)
```
:::

Expand Down
10 changes: 5 additions & 5 deletions ...urce/tutorials_and_integrations/tutorials/feedback/end2end_examples/add-vectors-004.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@
"metadata": {},
"outputs": [],
"source": [
"dataset.update_records(modified_records)"
"dataset_remote.update_records(modified_records)"
]
},
{
Expand All @@ -403,9 +403,9 @@
"source": [
"## Find Similar Records\n",
"\n",
"Now that we have the vectors for each record, let us see the semantic search in action. We can accomplish this via both the UI and PythonSDK. To find similar records in the UI, please refer to the [push the dataset](#Push-the-Dataset) section, where we upload the improved dataset to Argilla server and easily do semantic search. In this section, we will see how to do it within the PythonSDK.\n",
"Now that we have the vectors for each record, let's see the semantic search in action. We can accomplish this via both the UI and PythonSDK. To find similar records in the UI, please refer to the [push the dataset](#Push-the-Dataset) section, where we upload the improved dataset to Argilla server and easily do semantic search. In this section, we will see how to do it within the PythonSDK.\n",
"\n",
"To find similar records, we will use the `find_similar_records` method. We need to feed this method with the vector name we want to use for the search. For the particular vector, we have two options: we can either use a record by the `record` parameter or we can define a new vector by the `vector` parameter. You can limit the number of records you want to get by the `max_results` parameter. "
"To find similar records, we will use the `find_similar_records` method, which only works with a remote dataset. We need to feed this method with the vector name we want to use for the search. For the particular vector, we have two options: we can either use a record by the `record` parameter or we can define a new vector by the `vector` parameter. You can limit the number of records you want to get by the `max_results` parameter. "
]
},
{
Expand All @@ -414,9 +414,9 @@
"metadata": {},
"outputs": [],
"source": [
"similar_records = dataset.find_similar_records(\n",
"similar_records = dataset_remote.find_similar_records(\n",
" vector_name=\"sentence_embedding\",\n",
" record=dataset[0],\n",
" record=dataset_remote[0],\n",
" max_results=5\n",
")"
]
Expand Down
Loading