mindkosh 1.0.2__tar.gz

mindkosh-1.0.2/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   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.

mindkosh-1.0.2/PKG-INFO

@@ -0,0 +1,432 @@
+Metadata-Version: 2.4
+Name: mindkosh
+Version: 1.0.2
+Summary: Mindkosh Python SDK
+Home-page: https://github.com/Mindkosh/mindkosh-python-sdk
+Author: Mindkosh
+Author-email: shikhar@mindkosh.com
+License: Apache-2.0
+Keywords: annotation,segmentation,pointcloud,computervision
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests==2.31.0
+Requires-Dist: typing-extensions==4.7.1
+Requires-Dist: numpy==1.21.6
+Requires-Dist: Pillow==9.2.0
+Requires-Dist: kiwisolver==1.4.4
+Requires-Dist: matplotlib==3.5.1
+Requires-Dist: mplcursors==0.5.1
+Requires-Dist: aiohttp==3.8.6
+Requires-Dist: alive-progress==2.4.1
+Requires-Dist: validators==0.20.0
+Requires-Dist: python-dotenv==0.21.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+![mindkosh_logo_small](https://github.com/user-attachments/assets/2ee88693-028b-436c-9061-5ab318565c52)
+
+
+[Mindkosh](https://mindkosh.com/annotation-platform) is the platform for 
+labeling multi-sensor data, from Lidar point clouds to multiple camera images. Our powerful automatic annotation features and a particular focus on making Quality checking easier and faster, helps ML teams obtain high quality labeled datasets at scale.
+
+
+[Read documentation here](https://docs.mindkosh.com/getting-started/welcome)
+
+
+![github-sdk-page-image](https://github.com/user-attachments/assets/abbe6b88-3b86-4557-be87-8ed778ea093e)
+
+
+
+
+## Table of contents:
+- [Table of contents:](#table-of-contents)
+- [Setup](#setup)
+  - [Requirements](#requirements)
+  - [Installation](#installation)
+- [Getting started](#getting-started)
+- [Datasets](#datasets)
+  - [Create dataset](#create-dataset)
+  - [Get datasets](#get-datasets)
+  - [Get dataset files](#get-dataset-files)
+  - [Update tags](#update-tags)
+  - [Upload data](#upload-data)
+  - [Upload pointcloud data](#upload-pointcloud-data)
+  - [Upload imagefiles](#upload-imagefiles)
+  - [Delete files from dataset](#delete-files-from-dataset)
+  - [Delete dataset](#delete-dataset)
+- [Projects](#projects)
+  - [Create project](#create-project)
+  - [Get all projects](#get-all-projects)
+  - [Update project details](#update-project-details)
+  - [Delete project](#delete-project)
+- [Tasks](#tasks)
+  - [Create task](#create-task)
+  - [Get all tasks](#get-all-tasks)
+  - [Update task details](#update-task-details)
+  - [Download annotations](#download-annotations)
+  - [Upload annotations](#upload-annotations)
+  - [Delete task](#delete-task)
+- [Frames](#frames)
+  - [Get frames](#get-frames)
+  - [Download frame](#download-frame)
+  - [Show frame annotations](#show-frame-annotations)
+  - [Download frame annotations](#download-frame-annotations)
+  - [Visualize frame annotations](#visualize-frame-annotations)
+
+
+## Setup
+
+### Requirements
+
+* Python >= 3.7
+* Account on the Mindkosh platform (Create on now)
+* SDK Token (contact us to get one)
+
+
+### Installation
+
+* Install the package
+```sh
+pip install mindkosh
+```
+
+
+## Getting started
+
+```py
+from mindkosh import Client, PointCloudFile, ImageFile, Label
+client = Client(token)
+```
+
+To get started, create a Task/Project object using the token provided to you. You can also set the token
+in an environment variable(MK_TOKEN) instead of passing as a parameter to the object constructor.
+
+## Datasets
+
+### Create dataset
+```py
+client.create_dataset(
+    name: str, 
+    data_type: str
+) 
+```
+Parameters:
+* name - unique dataset name
+* data_type - image, pointcloud or video
+
+Example:
+```py
+dataset = client.create_dataset(
+    name = 'test-1',
+    data_type = 'pointcloud'
+)
+```
+
+### Get datasets
+```py
+datasets = client.get_datasets(
+    dataset_id = 1
+)
+```
+
+### Get dataset files
+```py
+files = client.get_dataset_files(
+    dataset_id = 1,
+    max_files = 100
+)
+```
+
+### Update tags
+```py
+updated_dataset_files = client.update_tags(
+    dataset_id = 1,
+    datasetfile_ids = [1,2,3,4,5,6,8],
+    add = ['tag1','tag2'],
+    remove = ['tag2'],
+    all = False
+)
+```
+
+### Upload data
+
+Uploads images from a list of directories or/and files.
+Useful when all the images same tags/extra.
+
+```py
+client.upload_data(
+    dataset_id = 1,
+    tags = ['tag4'],
+    resources = ['/home/user/Desktop/my-images/', '/home/user/Downloads/test1.jpg'],
+    recursive = False,
+    manifest_file = None,
+    save_files_dir = None,
+    **kwargs
+)
+```
+
+### Upload pointcloud data
+
+Uploads images from a list of directories or/and files.
+Useful when all the images same tags/extra.
+
+```py
+pcdfile1 = PointCloudFile(
+    filepath = '/file/path1/',
+    related_files = [
+        ImageFile(
+            filepath='/path/to/image1',
+            tags=[],
+            extra={
+                "intrinsic": [255.520403, 449.883682, 250.828738, 255.237477],
+
+                # Projection matrix from lidar to camera
+                "extrinsic": [
+                    [-0.735827, -0.65789, -0.0384775, 0],
+                    [0.6567956, -0.70452916, 0.00140833, 0],
+                    [-0.02255652, -0.0248216, 0.9993586, 0],
+                    [0, 0, 0, 1]
+                ],
+
+                # Camera projection model - PINHOLE OR FISHEYE
+                # For FISHEYE, mirrorParameter is also needed
+                "cameraModel": "PINHOLE",
+                "device_id": 1
+            }
+        )
+    ]
+)
+
+client.upload_pointcloud_data(
+    dataset_id = 1,
+    pcdfiles = [pcdfile1, pcdfile2]
+    **kwargs
+)
+```
+
+### Upload imagefiles
+
+Uploads images with tags/extra for each image
+
+```py
+client.upload_imagefiles(
+    dataset_id = 1,
+    imagefiles = [
+        ImageFile(
+            filepath='/path/to/image1',
+            tags=["city1"]
+        ),
+        ImageFile(
+            filepath='path/to/image2',
+            tags=["city2"]
+        )
+    ]
+)
+```
+
+### Delete files from dataset
+
+Delete select files or delete all the files from a dataset
+
+```py
+client.delete_files_from_dataset(
+    dataset_id = 1,
+    file_ids = [1,2,3,4],
+    delete_all = False
+)
+```
+
+### Delete dataset
+
+Delete a dataset along with its files
+
+```py
+client.delete_dataset(dataset_id=1)
+```
+
+## Projects
+
+### Create project
+```py
+project = client.project.create(name, description=None) 
+```
+To create a project, enter a name and an optional description.
+
+
+
+### Get all projects
+
+Get list of all project objects
+```py
+myprojects = client.project.get()
+```
+
+
+### Update project details
+
+```py
+project.update_name("new name")
+project.update_description("New description")
+```
+
+### Delete project
+```py
+project.delete()
+```
+
+## Tasks
+
+### Create task
+Create a new task :
+```py
+labels = [
+    Label(
+      name='car',
+      color='#fffccc',
+      sequence=1
+    ),
+    Label(
+      name='bus',
+      color='#fcf0fc',
+      sequence=2,
+      attributes =[]
+    )
+]
+```
+Note : Each label should have a unique name.
+
+```py
+task = client.task.create( 
+    name='task1',
+    labels=labels,
+    dataset_id=1,
+    tags=['tag1'],
+    project_id=None,
+    job_modes=['validation','qc']
+    batches=3
+)
+```
+To create a task and upload images/video, user must provide either `resources`/`manifest`.
+
+Parameters:
+* name - A valid task name.
+* batches - Number of images in each job. Only valid for resource_type="imageset".
+* project_id - Optional - ID of the project this task should belong to.
+
+
+### Get all tasks
+
+Get list of all the tasks
+```py
+mytasks = client.task.get()
+```
+
+
+### Update task details
+
+```py
+task.update_name("New name")
+task.update_project_id(new_valid_project_id)  
+```
+
+### Download annotations
+
+Get releases
+```py
+releases = task.get_releases()
+```
+
+Create a release
+
+```py
+releases = task.create_release(
+    format="coco", 
+    batches=[1,2], 
+    description=None, 
+    webhook_url=None
+)
+```
+
+format can be any of the following:
+
+* Available formats and their parameter names:
+* COCO - "coco"
+* Datumaro - "datumaro"
+* Pascal VOC - "voc"
+* Segmentation mask - "segmentation_mask"
+* YOLO - "yolo"
+
+Download a release
+```py
+task.download_release(
+    release_id=1,
+    local_path='/local/dir/'
+)
+```
+
+Delete a release
+```py
+task.delete_release(release_id=1)
+```
+
+### Upload annotations
+
+```py
+task.upload_annotations(
+    annotation_format='coco',
+    local_path='annotation_file.zip'
+) 
+```
+
+
+### Delete task
+Delete a task - 
+```py
+task.delete()
+```
+
+## Frames
+
+### Get frames
+```py
+frames = t1.frames()
+frame = frames[frame_id]
+```
+
+### Download frame
+```py
+frame.download(location)
+```
+
+### Show frame annotations
+```py
+frame.annotations
+```
+
+### Download frame annotations
+```py
+frame.download_annotations(location,format=None)
+```
+Parameters :
+
+* location - local dir location where you want to save annotations
+* format - None if you want to download row annotations. Any of ("coco", "datumaro", "voc", "yolo") if you want to download datasets in specific format.
+
+### Visualize frame annotations
+```py
+frame.visualize(show_annotations=True,fill_color=0.30)
+```
+Parameters :
+
+* show_annotations - False to see raw image, True to see image with annotations.
+* fill_color - 0 <= Color transparency <= 1