Changed import for Imagelab

README.md

@@ -33,7 +33,7 @@ wget -nc 'https://cleanlab-public.s3.amazonaws.com/CleanVision/image_files.zip'
 1. Run CleanVision to audit the images.
 
 ```python
-from cleanvision.imagelab import Imagelab
+from cleanvision import Imagelab
 
 # Specify path to folder containing the image files in your dataset
 imagelab = Imagelab(data_path="FOLDER_WITH_IMAGES/")

docs/source/index.rst

@@ -49,7 +49,7 @@ Quickstart
 
 .. code-block:: python3
 
-    from cleanvision.imagelab import Imagelab
+    from cleanvision import Imagelab
 
     # Specify path to folder containing the image files in your dataset
     imagelab = Imagelab(data_path="FOLDER_WITH_IMAGES/")

docs/source/tutorials/huggingface_dataset.ipynb

@@ -41,7 +41,7 @@
    "outputs": [],
    "source": [
     "from datasets import load_dataset, concatenate_datasets\n",
-    "from cleanvision.imagelab import Imagelab"
+    "from cleanvision import Imagelab"
    ]
   },
   {

docs/source/tutorials/run.py

@@ -1,6 +1,6 @@
 import argparse
 
-from cleanvision.imagelab import Imagelab
+from cleanvision import Imagelab
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(description="Demonstrates how to use Imagelab")

docs/source/tutorials/torchvision_dataset.ipynb

@@ -49,7 +49,7 @@
    "source": [
     "from torchvision.datasets import CIFAR10\n",
     "from torch.utils.data import ConcatDataset\n",
-    "from cleanvision.imagelab import Imagelab"
+    "from cleanvision import Imagelab"
    ]
   },
   {

docs/source/tutorials/tutorial.ipynb

@@ -120,7 +120,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from cleanvision.imagelab import Imagelab\n",
+    "from cleanvision import Imagelab\n",
     "\n",
     "# Path to your dataset, you can specify your own dataset path\n",
     "dataset_path = \"./image_files/\"\n",

src/cleanvision/__init__.py

@@ -1,4 +1,5 @@
 import sys
+from cleanvision.imagelab import Imagelab as _Imagelab
 
 PYTHON_VERSION_INFO = sys.version_info
 
@@ -18,3 +19,5 @@ def get_version() -> str:
     __version__ = get_version()
 except Exception:
     pass
+
+Imagelab = _Imagelab

src/cleanvision/imagelab.py

@@ -106,7 +106,7 @@ class Imagelab:
 
     .. code-block:: python
 
-        from cleanvision.imagelab import Imagelab
+        from cleanvision import Imagelab
         imagelab = Imagelab(data_path="FOLDER_WITH_IMAGES/")
         imagelab.find_issues()
         imagelab.report()
@@ -137,7 +137,7 @@ def __init__(
 
         # can be loaded from a file later
         self._config: Dict[str, Any] = self._set_default_config()
-        self.cleanvision_version = cleanvision.__version__
+        self.cleanvision_version: str = cleanvision.__version__
 
     def _set_default_config(self) -> Dict[str, Any]:
         """Sets default values for various config variables used in Imagelab class

src/cleanvision/utils/serialize.py

@@ -11,7 +11,7 @@
 import cleanvision
 
 if TYPE_CHECKING:  # pragma: no cover
-    from cleanvision.imagelab import Imagelab
+    from cleanvision import Imagelab
 
 # Constants:
 OBJECT_FILENAME = "imagelab.pkl"

tests/test_run.py

@@ -5,7 +5,7 @@
 from datasets import load_dataset
 
 from cleanvision.dataset.folder_dataset import FolderDataset
-from cleanvision.imagelab import Imagelab
+from cleanvision import Imagelab
 from cleanvision.issue_managers.image_property import BrightnessProperty
 from cleanvision.issue_managers.image_property_issue_manager import (
     compute_scores_wrapper,

tests/test_save_load.py

@@ -5,6 +5,8 @@
 from pandas.testing import assert_frame_equal, assert_series_equal
 
 import cleanvision
+
+# To ensure backwards compatibility
 from cleanvision.imagelab import Imagelab