Docs/end-to-end-tutorial

src/argilla_sdk/_helpers/_resource_repr.py

@@ -0,0 +1,58 @@
+from typing import Any, Dict
+
+from IPython.display import HTML
+
+
+RESOURCE_REPR_CONFIG = {
+    "Dataset": {
+        "columns": ["name", "id", "workspace_id", "updated_at", "records"],
+        "table_name": "Datasets",
+        # "len_column": "records",
+    },
+    "Workspace": {
+        "columns": ["name", "id", "datasets", "updated_at"],
+        "table_name": "Workspaces",
+        "len_column": "datasets",
+    },
+    "User": {"columns": ["username", "id", "role", "updated_at"], "table_name": "Users"},
+}
+
+
+class ResourceHTMLReprMixin:
+    def _resource_to_table_row(self, resource) -> Dict[str, Any]:
+        row = {}
+        dumped_resource_model = resource._model.model_dump()
+        resource_name = resource.__class__.__name__
+        config = RESOURCE_REPR_CONFIG[resource_name].copy()
+        len_column = config.pop("len_column", None)
+        columns = config["columns"]
+        if len_column is not None:
+            row[len_column] = len(resource)
+            columns = [column for column in columns if column != len_column]
+
+        for column in columns:
+            row[column] = dumped_resource_model[column]
+
+        return row
+
+    def _resource_to_table_name(self, resource) -> str:
+        resource_name = resource.__class__.__name__
+        return RESOURCE_REPR_CONFIG[resource_name]["table_name"]
+
+    def _represent_as_html(self, resources) -> HTML:
+        table_name = self._resource_to_table_name(resources[0])
+        table_rows = [self._resource_to_table_row(resource) for resource in resources]
+
+        html_table = f"<h3>{table_name}</h3><table><tr>"
+        for column in table_rows[0]:
+            html_table += f"<th>{column}</th>"
+        html_table += "</tr>"
+
+        for row in table_rows:
+            html_table += "<tr>"
+            for column in row:
+                html_table += f"<td>{row[column]}</td>"
+            html_table += "</tr>"
+
+        html_table += "</table>"
+        return HTML(html_table)._repr_html_()

src/argilla_sdk/_models/_settings/_fields.py

@@ -1,8 +1,7 @@
+from typing import Optional
 from uuid import UUID
 
-from pydantic import BaseModel, validator
-
-from typing import Optional
+from pydantic import BaseModel, validator, field_serializer
 
 from argilla_sdk._helpers._log import log
 
@@ -32,6 +31,10 @@ def __title_default(cls, title, values):
         log(f"TextField title is {validated_title}")
         return validated_title
 
+    @field_serializer("id", when_used="unless-none")
+    def serialize_id(self, value: UUID) -> str:
+        return str(value)
+
 
 class TextFieldModel(FieldBaseModel):
     settings: FieldSettings = FieldSettings(type="text", use_markdown=False)

src/argilla_sdk/client.py

@@ -11,12 +11,13 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
 from abc import abstractmethod
 from collections.abc import Sequence
 from typing import TYPE_CHECKING, overload
 
-import argilla_sdk as rg
 from argilla_sdk import _api
+from argilla_sdk._helpers._resource_repr import ResourceHTMLReprMixin
 
 if TYPE_CHECKING:
     from argilla_sdk import Workspace
@@ -44,7 +45,7 @@ def me(self) -> "User":
         return User(client=self, _model=self.api.users.get_me())
 
 
-class Users(Sequence):
+class Users(Sequence, ResourceHTMLReprMixin):
     """A collection of users. It can be used to create a new user or to get an existing one."""
 
     def __init__(self, client: "Argilla") -> None:
@@ -78,8 +79,12 @@ def __getitem__(self, index):
     def __len__(self) -> int:
         return len(self._api.list())
 
+    def _repr_html_(self) -> "HTML":
+        resources = [self[i] for i in range(len(self))]
+        return self._represent_as_html(resources=resources)
+
 
-class Workspaces(Sequence):
+class Workspaces(Sequence, ResourceHTMLReprMixin):
     """A collection of workspaces. It can be used to create a new workspace or to get an existing one."""
 
     def __init__(self, client: "Argilla") -> None:
@@ -114,8 +119,12 @@ def __getitem__(self, index: int) -> "Workspace":
     def __len__(self) -> int:
         return len(self._api.list())
 
+    def _repr_html_(self) -> "HTML":
+        resources = [self[i] for i in range(len(self))]
+        return self._represent_as_html(resources=resources)
 
-class Datasets(Sequence):
+
+class Datasets(Sequence, ResourceHTMLReprMixin):
     """A collection of datasets. It can be used to create a new dataset or to get an existing one."""
 
     def __init__(self, client: "Argilla") -> None:
@@ -150,3 +159,7 @@ def __getitem__(self, index) -> "Dataset":
 
     def __len__(self) -> int:
         return len(self._api.list())
+
+    def _repr_html_(self) -> "HTML":
+        resources = [self[i] for i in range(len(self))]
+        return self._represent_as_html(resources=resources)

src/argilla_sdk/datasets/_resource.py

@@ -71,6 +71,9 @@ def __init__(
         self.__records = DatasetRecords(client=self._client, dataset=self)
         self._sync(model=self._model)
 
+    def __len__(self) -> int:
+        return len(self.records)
+
     @property
     def records(self) -> "DatasetRecords":
         return self.__records

src/argilla_sdk/records/_dataset_records.py

@@ -94,6 +94,7 @@ def __init__(self, client: "Argilla", dataset: "Dataset"):
         """
         self.__client = client
         self.__dataset = dataset
+        self.__records = []
 
     def __iter__(self):
         return DatasetRecordsIterator(self.__dataset, self.__client)
@@ -114,6 +115,9 @@ def __call__(
             with_responses=with_responses,
         )
 
+    def __len__(self) -> int:
+        return len(self.__records)
+
     ############################
     # Public methods
     ############################
@@ -136,6 +140,7 @@ def add(
             message=f"Added {len(records_models)} records to dataset {self.__dataset.name}",
             level="info",
         )
+        self.__records = records_models
 
     def update(
         self, records: Union[dict, List[dict]], mapping: Optional[Dict[str, str]] = None, user_id: Optional[UUID] = None

src/argilla_sdk/workspaces/_resource.py

@@ -55,10 +55,21 @@ def __init__(
         super().__init__(client=client, api=client.api.workspaces)
         self._sync(model=WorkspaceModel(name=name, id=id) if not _model else _model)
 
+    def __len__(self) -> int:
+        return len(self.datasets)
+
     def list_datasets(self) -> List["DatasetModel"]:
         datasets = self._client.api.datasets.list(self.id)
         self.log(f"Got {len(datasets)} datasets for workspace {self.id}")
         return datasets
 
     def exists(self) -> bool:
         return self._api.exists(self.id)
+
+    ############################
+    # Properties
+    ############################
+
+    @property
+    def datasets(self) -> List["DatasetModel"]:
+        return self.list_datasets()