Update docs

Author: VaghinakDev

docs/source/userguide/quickstart.rst

@@ -101,7 +101,7 @@ To create a new "Vector" project with name "Example Project 1" and description
 
     project = "Example Project 1"
 
-    sa.create_project(project, "test", "Vector")
+    sa_client.create_project(project, "test", "Vector")
 
 ----------
 
@@ -115,7 +115,7 @@ To upload all images with extensions "jpg" or "png" from the
 
 .. code-block:: python
 
-    sa.upload_images_from_folder_to_project(project, "<local_folder_path>")
+    sa_client.upload_images_from_folder_to_project(project, "<local_folder_path>")
 
 See the full argument options for
 :py:func:`upload_images_from_folder_to_project` :ref:`here <ref_upload_images_from_folder_to_project>`.
@@ -144,19 +144,19 @@ To download the image one can use:
 
    image = "example_image1.jpg"
 
-   sa.download_image(project, image, "<path_to_local_dir>")
+   sa_client.download_image(project, image, "<path_to_local_dir>")
 
 To download image annotations:
 
 .. code-block:: python
 
-   sa.download_image_annotations(project, image, "<path_to_local_dir>")
+   sa_client.download_image_annotations(project, image, "<path_to_local_dir>")
 
 Upload back to the platform with:
 
 .. code-block:: python
 
-   sa.upload_image_annotations(project, image, "<path_to_json>")
+   sa_client.upload_image_annotations(project, image, "<path_to_json>")
 
 ---------
 
@@ -168,4 +168,4 @@ A team contributor can be invited to the team with:
 
 .. code-block:: python
 
-   sa.invite_contributors_to_team(emails=["admin@superannotate.com"], admin=False)
+   sa_client.invite_contributors_to_team(emails=["admin@superannotate.com"], admin=False)

docs/source/userguide/setup_project.rst

@@ -64,7 +64,7 @@ Form Editor.
         "environments": []
     }
 
-    response = sa.create_project(
+    response = sa_client.create_project(
         project_name="My Multimodal Project",
         project_description="Example multimodal project created via SDK",
         project_type="Multimodal",
@@ -76,15 +76,15 @@ After creating the project, you can create folders and generate items:
 .. code-block:: python
 
     # Create a new folder in the project
-    sa.create_folder(
+    sa_client.create_folder(
         project="My Multimodal Project",
         folder_name="First Folder"
     )
 
     # Generate multiple items in the specific project and folder
     # If there are no items in the folder, it will generate a blank item
     # otherwise, it will generate items based on the Custom Form
-    sa.generate_items(
+    sa_client.generate_items(
         project="My Multimodal Project/First Folder",
         count=10,
         name="My Item"
@@ -98,7 +98,7 @@ To upload annotations to these items:
         # list of annotation dicts
     ]
 
-    sa.upload_annotations(
+    sa_client.upload_annotations(
         project="My Multimodal Project/First Folder",
         annotations=annotations,
         keep_status=True,
@@ -115,7 +115,7 @@ To create a new "Vector" project with name "Example Project 1" and description
 
     project = "Example Project 1"
 
-    sa.create_project(project, "test", "Vector")
+    sa_client.create_project(project, "test", "Vector")
 
 
 Uploading images to project
@@ -127,7 +127,7 @@ To upload all images with extensions "jpg" or "png" from the
 
 .. code-block:: python
 
-    sa.upload_images_from_folder_to_project(project, "<local_folder_path>")
+    sa_client.upload_images_from_folder_to_project(project, "<local_folder_path>")
 
 See the full argument options for
 :py:func:`upload_images_from_folder_to_project` :ref:`here <ref_upload_images_from_folder_to_project>`.
@@ -150,7 +150,7 @@ To create a new folder "folder1" in the project "Example Project 1":
 
 .. code-block:: python
 
-    sa.create_folder(project, "folder1")
+    sa_client.create_folder(project, "folder1")
 
 After that point almost all SDK functions that use project name as argument can
 point to that folder with slash after the project name, e.g.,
@@ -162,7 +162,7 @@ point to that folder with slash after the project name, e.g.,
 
       .. code-block:: python
 
-         sa.upload_images_from_folder_to_project(project + "/folder1", "<local_folder_path>")
+         sa_client.upload_images_from_folder_to_project(project + "/folder1", "<local_folder_path>")
 
 Working with annotation classes
 ===============================
@@ -171,7 +171,7 @@ An annotation class for a project can be created with SDK's:
 
 .. code-block:: python
 
-   sa.create_annotation_class(project, "Large car", color="#FFFFAA")
+   sa_client.create_annotation_class(project, "Large car", color="#FFFFAA")
 
 
 To create annotation classes in bulk with SuperAnnotate export format
@@ -181,7 +181,7 @@ https://superannotate.readthedocs.io/en/stable/userguide/setup_project.html#work
 
 .. code-block:: python
 
-   sa.create_annotation_classes_from_classes_json(project, "<path_to_classes_json>")
+   sa_client.create_annotation_classes_from_classes_json(project, "<path_to_classes_json>")
 
 
 All of the annotation classes of a project are downloaded (as :file:`classes/classes.json`) with
@@ -190,7 +190,7 @@ can also be downloaded separately with:
 
 .. code-block:: python
 
-   sa.download_annotation_classes_json(project, "<path_to_local_folder>")
+   sa_client.download_annotation_classes_json(project, "<path_to_local_folder>")
 
 The :file:`classes.json` file will be downloaded to :file:`"<path_to_local_folder>"` folder.
 
@@ -245,7 +245,7 @@ you are uploading to should contain annotation class with that name.
 
 .. code-block:: python
 
-    sa.upload_annotations_from_folder_to_project(project, "<path_to_local_dir>")
+    sa_client.upload_annotations_from_folder_to_project(project, "<path_to_local_dir>")
 
 
 This will try uploading to the project all the JSON files in the folder that have :file:`"<image_name>.json"` postfix.
@@ -262,13 +262,13 @@ To export the project annotations we need to prepare the export first:
 
 .. code-block:: python
 
-   export = sa.prepare_export(project, include_fuse=True)
+   export = sa_client.prepare_export(project, include_fuse=True)
 
 We can download the prepared export with:
 
 .. code-block:: python
 
-   sa.download_export(project, export, "<local_folder_path>", extract_zip_contents=True)
+   sa_client.download_export(project, export, "<local_folder_path>", extract_zip_contents=True)
 
 :ref:`download_export <ref_download_export>` will wait until the export is
 finished preparing and download it to the specified folder.

docs/source/userguide/utilities.rst

@@ -20,7 +20,7 @@ to convert them to other annotation formats:
 
 .. code-block:: python
 
-    sa.export_annotation("<input_folder>", "<output_folder>", "<dataset_format>", "<dataset_name>",
+    sa_client.export_annotation("<input_folder>", "<output_folder>", "<dataset_format>", "<dataset_name>",
     "<project_type>", "<task>")
 
 .. note::
@@ -197,10 +197,10 @@ Example Python Script:
     csv_to_jsonl("annotations.csv", "annotations.jsonl")
 
     # Upload to SuperAnnotate
-    sa = SAClient()
+    sa_client = SAClient()
     annotations = [json.loads(line) for line in Path("annotations.jsonl").open("r", encoding="utf-8")]
 
-    response = sa.upload_annotations(
+    response = sa_client.upload_annotations(
         project="project1/folder1",
         annotations=annotations,
         keep_status=True,
@@ -214,7 +214,7 @@ Fetching Annotations and Converting to JSONL/CSV
 Steps to Retrieve and Convert Annotations:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-1. Fetch **annotations from SuperAnnotate** using `sa.get_annotations()`.
+1. Fetch **annotations from SuperAnnotate** using `sa_client.get_annotations()`.
 2. Convert the **annotation list into JSONL format**.
 3. Convert the **JSONL data into CSV** for external use.
 
@@ -230,8 +230,8 @@ Python Script to Convert Annotations to JSONL:
                 jsonl_file.write('\n')
 
     # Fetch annotations from SuperAnnotate
-    sa = SAClient()
-    annotations = sa.get_annotations("project", data_spec="multimodal")
+    sa_client = SAClient()
+    annotations = sa_client.get_annotations("project", data_spec="multimodal")
 
     # Convert to JSONL
     convert_annotations_to_jsonl(annotations, "fetched_annotations.jsonl")
@@ -284,7 +284,7 @@ SuperAnnotate format annotations:
 
 .. code-block:: python
 
-   df = sa.aggregate_annotations_as_df("<path_to_project_folder>")
+   df = sa_client.aggregate_annotations_as_df("<path_to_project_folder>")
 
 The created DataFrame will have columns specified at
 :ref:`aggregate_annotations_as_df <ref_aggregate_annotations_as_df>`.