hirundo 0.1.16__py3-none-any.whl → 0.1.21__py3-none-any.whl

{hirundo-0.1.16.dist-info → hirundo-0.1.21.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hirundo
-Version: 0.1.16
+Version: 0.1.21
 Summary: This package is used to interface with Hirundo's platform. It provides a simple API to optimize your ML datasets.
 Author-email: Hirundo <dev@hirundo.io>
 License: MIT License
@@ -13,7 +13,7 @@ License: MIT License
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
         
-Project-URL: Homepage, https://github.com/Hirundo-io/hirundo-client
+Project-URL: Homepage, https://github.com/Hirundo-io/hirundo-python-sdk
 Keywords: dataset,machine learning,data science,data engineering
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
@@ -32,6 +32,10 @@ Requires-Dist: httpx>=0.27.0
 Requires-Dist: stamina>=24.2.0
 Requires-Dist: httpx-sse>=0.4.0
 Requires-Dist: tqdm>=4.66.5
+Requires-Dist: h11>=0.16.0
+Requires-Dist: requests>=2.32.4
+Requires-Dist: urllib3>=2.5.0
+Requires-Dist: setuptools>=78.1.1
 Provides-Extra: dev
 Requires-Dist: pyyaml>=6.0.1; extra == "dev"
 Requires-Dist: types-PyYAML>=6.0.12; extra == "dev"
@@ -46,69 +50,94 @@ Requires-Dist: stamina>=24.2.0; extra == "dev"
 Requires-Dist: httpx-sse>=0.4.0; extra == "dev"
 Requires-Dist: pytest>=8.2.0; extra == "dev"
 Requires-Dist: pytest-asyncio>=0.23.6; extra == "dev"
-Requires-Dist: uv>=0.5.8; extra == "dev"
+Requires-Dist: uv>=0.8.6; extra == "dev"
 Requires-Dist: pre-commit>=3.7.1; extra == "dev"
 Requires-Dist: virtualenv>=20.6.6; extra == "dev"
-Requires-Dist: ruff>=0.11.6; extra == "dev"
+Requires-Dist: ruff>=0.12.0; extra == "dev"
 Requires-Dist: bumpver; extra == "dev"
 Requires-Dist: platformdirs>=4.3.6; extra == "dev"
 Requires-Dist: safety>=3.2.13; extra == "dev"
+Requires-Dist: cryptography>=44.0.1; extra == "dev"
+Requires-Dist: jinja2>=3.1.6; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx>=7.4.7; extra == "docs"
-Requires-Dist: sphinx-autobuild>=2024.4.16; extra == "docs"
+Requires-Dist: sphinx-autobuild>=2024.9.3; extra == "docs"
 Requires-Dist: sphinx-click>=5.0.1; extra == "docs"
 Requires-Dist: autodoc_pydantic>=2.2.0; extra == "docs"
 Requires-Dist: furo; extra == "docs"
 Requires-Dist: sphinx-multiversion; extra == "docs"
 Requires-Dist: esbonio; extra == "docs"
-Requires-Dist: starlette>0.40.0; extra == "docs"
+Requires-Dist: starlette>=0.47.2; extra == "docs"
 Requires-Dist: markupsafe>=3.0.2; extra == "docs"
+Requires-Dist: jinja2>=3.1.6; extra == "docs"
 Provides-Extra: pandas
-Requires-Dist: pandas>=2.2.2; extra == "pandas"
+Requires-Dist: pandas>=2.2.3; extra == "pandas"
 Provides-Extra: polars
 Requires-Dist: polars>=1.0.0; extra == "polars"
 Dynamic: license-file
 
 # Hirundo
 
-This package exposes access to Hirundo APIs for dataset optimization for Machine Learning.
-
-Dataset optimization is currently available for datasets labelled for classification and object detection.
+This package exposes access to Hirundo APIs for dataset QA for Machine Learning.
 
+Dataset QA is currently available for datasets labelled for classification and object detection.
 
 Support dataset storage configs include:
-   - Google Cloud (GCP) Storage
-   - Amazon Web Services (AWS) S3
-   - Git LFS (Large File Storage) repositories (e.g. GitHub or HuggingFace)
+
+- Google Cloud (GCP) Storage
+- Amazon Web Services (AWS) S3
+- Git LFS (Large File Storage) repositories (e.g. GitHub or HuggingFace)
+
+Note: This Python package must be used alongside a Hirundo server, either the SaaS platform, a custom VPC deployment or an on-premises installation.
 
 Optimizing a classification dataset
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Currently ``hirundo`` requires a CSV file with the following columns (all columns are required):
-   - ``image_path``: The location of the image within the dataset ``root``
-   - ``label``: The label of the image, i.e. which the class that was annotated for this image
+Currently `hirundo` requires a CSV file with the following columns (all columns are required):
+
+- `image_path`: The location of the image within the dataset `data_root_url`
+- `class_name`: The semantic label, i.e. the class name of the class that the image was annotated as belonging to
+
+And outputs two Pandas DataFrames with the dataset columns as well as:
+
+Suspect DataFrame (filename: `mislabel_suspects.csv`) columns:
 
-And outputs a CSV with the same columns and:
-   - ``suspect_level``: mislabel suspect level
-   - ``suggested_label``: suggested label
-   - ``suggested_label_conf``: suggested label confidence
+- ``suspect_score``: mislabel suspect score
+- ``suspect_level``: mislabel suspect level
+- ``suspect_rank``: mislabel suspect ranking
+- ``suggested_class_name``: suggested semantic label
+- ``suggested_class_conf``: suggested semantic label confidence
+
+Errors and warnings DataFrame (filename: `invalid_data.csv`) columns:
+
+   - ``status``: status message (one of ``NO_LABELS`` / ``MISSING_IMAGE`` / ``INVALID_IMAGE``)
 
 Optimizing an object detection (OD) dataset
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Currently ``hirundo`` requires a CSV file with the following columns (all columns are required):
-   - ``image_path``: The location of the image within the dataset ``root``
-   - ``bbox_id``: The index of the bounding box within the dataset. Used to indicate label suspects
-   - ``label``: The label of the image, i.e. which the class that was annotated for this image
-   - ``x1``, ``y1``, ``x2``, ``y2``: The bounding box coordinates of the object within the image
 
-And outputs a CSV with the same columns and:
-   - ``suspect_level``: object mislabel suspect level
-   - ``suggested_label``: suggested object label
-   - ``suggested_label_conf``: suggested object label confidence
+- ``image_path``: The location of the image within the dataset ``data_root_url``
+- ``object_id``: The ID of the bounding box within the dataset. Used to indicate object suspects
+- ``class_name``: Object semantic label, i.e. the class name of the object that was annotated
+- ``xmin``: leftmost horizontal pixel coordinate of the object's bounding box
+- ``ymin``: uppermost vertical pixel coordinate of the object's bounding box
+- ``xmax``: rightmost horizontal pixel coordinate of the object's bounding box
+- ``ymax``: lowermost vertical pixel coordinate of the object's bounding box
 
-Note: This Python package must be used alongside a Hirundo server, either the SaaS platform, a custom VPC deployment or an on-premises installation.
 
+And outputs two Pandas DataFrames with the dataset columns as well as:
+
+Suspect DataFrame (filename: `mislabel_suspects.csv`) columns:
+
+- ``suspect_score``: object mislabel suspect score
+- ``suspect_level``: object mislabel suspect level
+- ``suspect_rank``: object mislabel suspect ranking
+- ``suggested_class_name``: suggested object semantic label
+- ``suggested_class_conf``: suggested object semantic label confidence
+
+Errors and warnings DataFrame (filename: `invalid_data.csv`) columns:
+   - ``status``: status message (one of ``NO_LABELS`` / ``MISSING_IMAGE`` / ``INVALID_IMAGE`` / ``INVALID_BBOX`` / ``INVALID_BBOX_SIZE``)
 
 ## Installation
 
@@ -117,11 +146,12 @@ You can install the codebase with a simple `pip install hirundo` to install the
 ## Usage
 
 Classification example:
+
 ```python
 from hirundo import (
     HirundoCSV,
     LabelingType,
-    OptimizationDataset,
+    QADataset,
     StorageGCP,
     StorageConfig,
     StorageTypes,
@@ -132,7 +162,7 @@ gcp_bucket = StorageGCP(
     project="Hirundo-global",
     credentials_json=json.loads(os.environ["GCP_CREDENTIALS"]),
 )
-test_dataset = OptimizationDataset(
+test_dataset = QADataset(
     name="TEST-GCP cifar 100 classification dataset",
     labeling_type=LabelingType.SINGLE_LABEL_CLASSIFICATION,
     storage_config=StorageConfig(
@@ -147,12 +177,11 @@ test_dataset = OptimizationDataset(
     classes=cifar100_classes,
 )
 
-test_dataset.run_optimization()
+test_dataset.run_qa()
 results = test_dataset.check_run()
 print(results)
 ```
 
-
 Object detection example:
 
 ```python
@@ -160,7 +189,7 @@ from hirundo import (
     GitRepo,
     HirundoCSV,
     LabelingType,
-    OptimizationDataset,
+    QADataset,
     StorageGit,
     StorageConfig,
     StorageTypes,
@@ -173,7 +202,7 @@ git_storage = StorageGit(
     ),
     branch="main",
 )
-test_dataset = OptimizationDataset(
+test_dataset = QADataset(
     name="TEST-HuggingFace-BDD-100k-validation-OD-validation-dataset",
     labeling_type=LabelingType.OBJECT_DETECTION,
     storage_config=StorageConfig(
@@ -187,30 +216,15 @@ test_dataset = OptimizationDataset(
             path="/BDD100K Val from Hirundo.zip/bdd100k/bdd100k.csv"
         ),
     ),
-    classes=[
-        "traffic light",
-        "traffic sign",
-        "car",
-        "pedestrian",
-        "bus",
-        "truck",
-        "rider",
-        "bicycle",
-        "motorcycle",
-        "train",
-        "other vehicle",
-        "other person",
-        "trailer",
-    ],
 )
 
-test_dataset.run_optimization()
+test_dataset.run_qa()
 results = test_dataset.check_run()
 print(results)
 ```
 
-Note: Currently we only support the main CPython release 3.9, 3.10 and 3.11. PyPy support may be introduced in the future.
+Note: Currently we only support the main CPython release 3.9, 3.10, 3.11, 3.12 & 3.13. PyPy support may be introduced in the future.
 
 ## Further documentation
 
-To learn more about how to use this library, please visit the [http://docs.hirundo.io/](documentation) or see the Google Colab examples.
+To learn more about how to use this library, please visit the [http://docs.hirundo.io/](documentation) or see the [Google Colab examples](https://github.com/Hirundo-io/hirundo-python-sdk/tree/main/notebooks).

hirundo-0.1.21.dist-info/RECORD

@@ -0,0 +1,25 @@
+hirundo/__init__.py,sha256=GxRK_DHPKG1aqxNa19imqspHRAvBHSAQ5Q0fDwJPCDE,1341
+hirundo/__main__.py,sha256=wcCrL4PjG51r5wVKqJhcoJPTLfHW0wNbD31DrUN0MWI,28
+hirundo/_constraints.py,sha256=slW7Rk9Ml5fuwjnXTLUvHIhnY_9hmcUUy57v9hFog1o,6003
+hirundo/_dataframe.py,sha256=sXEEbCNcLi83wyU9ii884YikCzfASo_3nnrDxhuCv7U,758
+hirundo/_env.py,sha256=efX2sjvYlHkFr2Lcstelei67YSTFpVGT0l08ZsfiMuE,622
+hirundo/_headers.py,sha256=Cwha8gXEQNXL2lc9Lb1klLotkMLD82XOpAdX33TLVj8,521
+hirundo/_http.py,sha256=0kfoznumU3jinHhJIpB6qn5Mt4a3kso59GNXVbpWH7M,2267
+hirundo/_iter_sse_retrying.py,sha256=xNpf3W5qAHkKPJz8H4NZjKE3CrI_8b3m1iYeahdpdEc,4653
+hirundo/_timeouts.py,sha256=gE58NU0t2e4KgKq2sk5rZcezDJAkgvRIbM5AVYFY6Ho,86
+hirundo/_urls.py,sha256=0C85EbL0T-Bj25vJwjNs_obUG8ROSADpmbFdTAyhzlw,1375
+hirundo/cli.py,sha256=u-LsrN17-J7temjrq6NeUGnJ4mO04tMCiQYqVMm6el8,7752
+hirundo/dataset_enum.py,sha256=QnS3fy1OF4wvUtiIAHubKRhc611idS8huopEEolgqEM,1217
+hirundo/dataset_qa.py,sha256=U7cqV4JbYkaByXEf2XdoJrQZ_rI9pgDxrXVbQLc50R8,32470
+hirundo/dataset_qa_results.py,sha256=1F7JhRf7TQomwW9tjbNn8OBrhWHwEaWOND80r39l5uY,1104
+hirundo/git.py,sha256=cBjP7kPnaUHR77FI5ZaERst38eTUDy8q1gAQzy45EB4,6567
+hirundo/labeling.py,sha256=zXQCaqfdaLIG4qbzFGbb94L3FDdRMpdzHwbrDJE07Yk,5006
+hirundo/logger.py,sha256=MUqrYp0fBlxWFhGl6P5t19_uqO7T_PNhrLN5bqY3i7s,275
+hirundo/storage.py,sha256=MPKxkhrBmX84Yuexd4QoLDdVIJHrll9RosCLUsz5q3c,15936
+hirundo/unzip.py,sha256=3aPOsBvF-ZgAumHnQ6hq7JtbFUe9eRRRFsiI6K8cRDE,8188
+hirundo-0.1.21.dist-info/licenses/LICENSE,sha256=fusGGjqT2RGlU6kbkaOk7d-gDnsjk17wq67AO0mwBZI,1065
+hirundo-0.1.21.dist-info/METADATA,sha256=3m7R5dMN5h_C-L2Wl76lzYjpreP5upyHcEkIoAZF1lY,9497
+hirundo-0.1.21.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+hirundo-0.1.21.dist-info/entry_points.txt,sha256=4ZtnA_Nl1Af8fLnHp3lwjbGDEGU1S6ujb_JwtuQ7ZPM,44
+hirundo-0.1.21.dist-info/top_level.txt,sha256=cmyNqrNZOAYxnywJGFI1AJBLe4SkH8HGsfFx6ncdrbI,8
+hirundo-0.1.21.dist-info/RECORD,,

{hirundo-0.1.16.dist-info → hirundo-0.1.21.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (79.0.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

hirundo-0.1.16.dist-info/RECORD

@@ -1,23 +0,0 @@
-hirundo/__init__.py,sha256=qKC89bNReZSjGtmf7l3PZD2JoptyVphpsD0Kf2PNXvY,1035
-hirundo/__main__.py,sha256=wcCrL4PjG51r5wVKqJhcoJPTLfHW0wNbD31DrUN0MWI,28
-hirundo/_constraints.py,sha256=gRv7fXwtjPGqYWIhkVYxu1B__3PdlYRqFyDkTpa9f74,1032
-hirundo/_dataframe.py,sha256=sXEEbCNcLi83wyU9ii884YikCzfASo_3nnrDxhuCv7U,758
-hirundo/_env.py,sha256=efX2sjvYlHkFr2Lcstelei67YSTFpVGT0l08ZsfiMuE,622
-hirundo/_headers.py,sha256=3hybpD_X4SODv3cFZPt9AjGY2vvZaag5OKT3z1SHSjA,521
-hirundo/_http.py,sha256=izlnuxStyPugjTAbD8Lo30tA4lZJ5d3kOENNduqrbX4,573
-hirundo/_iter_sse_retrying.py,sha256=U331_wZRIbVzi-jnMqo8bp9jBC8MtFBLEs-X0ZvhSDw,4634
-hirundo/_timeouts.py,sha256=gE58NU0t2e4KgKq2sk5rZcezDJAkgvRIbM5AVYFY6Ho,86
-hirundo/cli.py,sha256=5Tn0eXZGG92BR9HJYUaYozjFbS1t6UTw_I2R0tZBE04,7824
-hirundo/dataset_enum.py,sha256=ZEYBP-lrlVqfNWptlmw7JgLNhCyDirtWWPtoMvtg2AE,531
-hirundo/dataset_optimization.py,sha256=jR4ZOlKKl05jrA4cq9L1IQuKVPJ3ytXkhOJEg6efFqI,31390
-hirundo/dataset_optimization_results.py,sha256=A9YyF5zaZXVtzeDE08I_05v90dhZQADpSjDcS_6eLMc,1129
-hirundo/git.py,sha256=6h1hFPlw5FfYMGWXPCitnTqGICmBKmQtb5qKGe3Icmk,6580
-hirundo/logger.py,sha256=MUqrYp0fBlxWFhGl6P5t19_uqO7T_PNhrLN5bqY3i7s,275
-hirundo/storage.py,sha256=kO-LWlQAM3qTnALEl8s79AiFMYqCG9Sem4MIFQcyvAg,15950
-hirundo/unzip.py,sha256=XJqvt2m5pWR-G-fnzgW75VOdd-K4_Rw2r4wiEhZgKZA,8245
-hirundo-0.1.16.dist-info/licenses/LICENSE,sha256=fusGGjqT2RGlU6kbkaOk7d-gDnsjk17wq67AO0mwBZI,1065
-hirundo-0.1.16.dist-info/METADATA,sha256=CxdCbzafRuVRf1BGsS_tgjodO0g745uuNBl7y4UFMj8,8501
-hirundo-0.1.16.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
-hirundo-0.1.16.dist-info/entry_points.txt,sha256=4ZtnA_Nl1Af8fLnHp3lwjbGDEGU1S6ujb_JwtuQ7ZPM,44
-hirundo-0.1.16.dist-info/top_level.txt,sha256=cmyNqrNZOAYxnywJGFI1AJBLe4SkH8HGsfFx6ncdrbI,8
-hirundo-0.1.16.dist-info/RECORD,,