Skip to content

Commit

Permalink
Updates to User client (#451)
Browse files Browse the repository at this point in the history
  • Loading branch information
Laverne-Encord authored Oct 18, 2023
1 parent 2308da3 commit e141932
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
3 changes: 3 additions & 0 deletions docs/source/general_concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ The user authenticated to interact with the |company| platform.
The user has access to the resources and capabilities that are also available on the |platform|.
For a |platform| specific description of capabilities, please refer to the :xref:`docs_main_entry`.

> 👍 Tip
>For collaborative teams using our SDK, we recommend creating shared service accounts and creating SSH keys for those shared accounts. For example, to have several people create ontologies, datasets, and projects programatically, create an email account for use with Encord (for example, [email protected]) and generate an SSH for that email account.

Dataset
=======
The space where the data itself lives.
Expand Down
3 changes: 3 additions & 0 deletions docs/source/tutorials/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,9 @@ Users can be added to an existing project using their emails.
You can specify the role of the users being added using the :class:`.ProjectUserRole` enum.
You can find more details of the different roles in the :class:`doc-strings <.ProjectUserRole>`.

> 👍 Tip
>For collaborative teams using our SDK, we recommend creating shared service accounts and creating SSH keys for those shared accounts. For example, to have several people create ontologies, datasets, and projects programatically, create an email account for use with Encord (for example, [email protected]) and generate an SSH for that email account.

Below is an example of how to add two new annotators to the project.
Note how all users get assigned the same role.

Expand Down
4 changes: 2 additions & 2 deletions encord/user_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ def get_dataset(
self, dataset_hash: str, dataset_access_settings: DatasetAccessSettings = DEFAULT_DATASET_ACCESS_SETTINGS
) -> Dataset:
"""
Get the Project class to access project fields and manipulate a project.
Get the Dataset class to access dataset fields and manipulate a dataset.
You will only have access to this project if you are one of the following
You only have access to this project if you are one of the following
* Dataset admin
Expand Down

0 comments on commit e141932

Please sign in to comment.