Added ingest_coco to docs

puyuanOT · Dec 29, 2022 · 6495799 · 6495799
1 parent 24ed905
commit 6495799
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/deeplake/api/dataset.py b/deeplake/api/dataset.py
@@ -1004,7 +1004,7 @@ def connect(
     def ingest_coco(
         images_directory: Union[str, pathlib.Path],
         annotation_files: Union[str, pathlib.Path, List[str]],
-        dest: Union[str, pathlib.Path, Dataset],
+        dest: Union[str, pathlib.Path],
         key_to_tensor_mapping: Optional[Dict] = None,
         file_to_group_mapping: Optional[Dict] = None,
         ignore_one_group: bool = False,

diff --git a/docs/source/Datasets.rst b/docs/source/Datasets.rst
@@ -14,6 +14,7 @@ Creating Datasets
     deeplake.empty
     deeplake.like
     deeplake.ingest
+    deeplake.ingest_coco
     deeplake.ingest_kaggle
     deeplake.ingest_dataframe
     deeplake.ingest_huggingface

diff --git a/docs/source/deeplake.api.dataset.rst b/docs/source/deeplake.api.dataset.rst
@@ -42,6 +42,10 @@ deeplake.api.dataset
     .. staticmethod:: ingest(src: Union[str, pathlib.Path], dest: Union[str, pathlib.Path], images_compression: str = "auto", dest_creds: dict = None, progressbar: bool = True, summary: bool = True, **dataset_kwargs) -> Dataset
 
         See :func:`deeplake.ingest`.
+
+    .. staticmethod:: ingest_coco(images_directory: Union[str, pathlib.Path], annotation_files: Union[str, pathlib.Path, List[str]], dest: Union[str, pathlib.Path], key_to_tensor_mapping: Optional[Dict] = None, file_to_group_mapping: Optional[Dict] = None, ignore_one_group: bool = False, ignore_keys: Optional[List[str]] = None, image_settings: Optional[Dict] = None, src_creds: Optional[Dict] = None, dest_creds: Optional[Dict] = None, inspect_limit: int = 1000000, progressbar: bool = True, num_workers: int = 0, **dataset_kwargs) -> Dataset
+
+        See :func:`deeplake.ingest_coco`.
 
     .. staticmethod:: ingest_kaggle(tag: str, src: Union[str, pathlib.Path], dest: Union[str, pathlib.Path], exist_ok: bool = False, images_compression: str = "auto", dest_creds: dict = None, kaggle_credentials: dict = None, progressbar: bool = True, summary: bool = True, **dataset_kwargs) -> Dataset
 

diff --git a/docs/source/deeplake.rst b/docs/source/deeplake.rst
@@ -8,6 +8,7 @@ deeplake
 .. autofunction:: empty
 .. autofunction:: like
 .. autofunction:: ingest
+.. autofunction:: ingest_coco
 .. autofunction:: ingest_kaggle
 .. autofunction:: ingest_dataframe
 .. autofunction:: ingest_huggingface