Python 3 library providing access to Kognic IO
To install with pip run pip install kognic-io
Documentation about how to use the library can be found here
All notable changes to this project will be documented in this file.
KognicIOClient constructor. A value is inferred if it's left blank.workspace resource to the clientclient.workspace.get_workspacesAddFeedbackItemReviewMemberReviewget_review: Get a review by its uuidcreate_review: Create a reviewget_error_types: Get all error typeskognicutil. Can be used to list scenes with kognicutil scenes uuid1 uuid2kognic-base-clients to 2.3.4max_connection parameter in resource clients to allow for more control over the number of network connectionsOptional fields to handle pydantic v2.0.0kognic.io.tools.calibration.validation for validating custom camera calibrationskognic.io.tools.calibration.compilation for compiling custom camera calibrations to WebAssemblyclient.input.query_inputs(...)create_from_scene(...) now returns created inputsInput model representing a scene in a requestCustomCameraCalibration using WebAssemblyget_inputs_with_uuids (use get_scenes_by_uuids instead)get_inputs (use query_inputs instead)kognic.io.model.input.input_entry.Input model along with kognic.io.model.input.input_entry.InputStatusclient.scene.get_scenes_by_uuids([...])client.annotation.get_annotation_for_input(input_uuid)client.annotation.get_annotations_for_scene(scene_uuid)client.scene.invalidate_scenes([scene_uuid, ...], reason)client.input.delete_input(input_uuid)input_type field on Input to scene_typeinput_uuid to scene_uuid on the following methods
client.annotation.get_annotationclient.input.invalidate_inputsclient.input.add_annotation_typeclient.input.remove_annotation_typesclient.input.get_inputs_by_uuidsinput_uuid parameter in get_annotation to scene_uuidinvalidate_inputs (use invalidate_scenes instead)remove_annotation_types (use delete_input instead)input_type on the Input model (use scene_type instead)input_uuid parameter in favour of scene_uuid on the following methods
client.annotation.get_annotationclient.input.invalidate_inputsclient.input.add_annotation_typeclient.input.remove_annotation_typesclient.input.get_inputs_by_uuidsFileDataFileData.Format.WEBP to enable use of WebP for FileData images (which were already supported for InputModel.Image)lidar_and_cameras attribute to lidars_and_cameras on KognicIOClientuuid field on Input to scene_uuidinput_uuid field on Annotation to scene_uuidcreate method from CreateInputResponse to CreateSceneResponse. Also renamed input_uuid field to scene_uuid in the response.InvalidatedReasonInput to InvalidatedReasonSceneLidarsAndCameras) from kognic.io.model.input to kognic.io.model.scenelidar_and_cameras attribute on KognicIOClientuuid field on Inputinput_uuid field on AnnotationCreateInputResponse response from create method along with its input_uuid fieldInvalidatedReasonInputkognic.io.model.inputImage and PointCloud filename must refer to a file that exists & contain data unless a callback or raw bytes are provided.
(i.e. there is no validation any time FileData are used)Pillowif calibration.calibration_type == CalibrationType.PINHOLE to fail in some cases.create_inputs that allows creation of multiple inputs (with or without a pre-annotation) with a single call. This is useful since it contains wait-logic for the scene to be ready before creating inputs.False.aggregated_lidars_and_cameras_sequence. This new input type is a sequence of cameras
and point clouds, but the point clouds are aggregated over time. More information can be found here.include_content in get_project_annotations that lets you choose whether to fetch the annotation content
or notkognic-base-clients to 1.0.3 which introduces retry when uploads fail for TCP or SSL timeout reasons.Image, PointCloud) may now be provided in different ways:
Refer to the updated documentation for details about how to use the new API features.
metadata is once again an optional attribute on model classes that use it (CamerasSequence among others)kognic-base-clients to 1.0.1get_inputs method to prevent timeoutsThis is a major release with breaking changes and refactorings. Please refer to our Annotell-2-Kognic migration guide for details.
@dataclasses in our model packages are now pydantic models with better validationget_annotations methodannotell.input_api.model.calibration.sensors.LidarCalibration
annotell.input_api.model.calibration.{camera, lidar}.*,
refer to the calibration documentation for details.internalId to sceneUuid on initialize inputannotell.input_api.model.calibration.sensors.CameraCalibration
annotell.input_api.model.calibration.{camera, lidar}.*,
refer to the calibration documentation for details.annotell-base-clients is now a dependency for annotell-input-api, used for http requests and file uploadsclient.annotation.get_project_annotations will now reliably iterate projects with thousands of annotationsannotation_types in Inputremove_annotation_typesregion.file_resource_client.py, split upload and download into separate classes.timeout to InputApiClient, which decides what the timeout in seconds is for calls to Annotell API:s and Google Cloud Storage.ConnectionError is raised during uploading/downloading of resources to/from Google Cloud Storage.Pending. An input will have this status if the input has been validated, but the server is waiting for the associated data to
be uploaded. When all data is uploaded the status of the input will change to Processing.Two new methods has been added for downloading annotations: client.annotation.get_annotation and client.annotation.get_project_annotations. These two methods will serve annotations
in the OpenLABEL format. With this change the previous method for fetching annotations,
client.annotation.get_annotations has become deprecated.
Stricter typing for the calibrations, specifically the camera calibrations. Each of the supported camera calibration models now have their own class in annotell.input_api.model.calibration.camera. Documentation regarding use can be found here: Documentation
Field of View support for camera calibrations
New Parameter Xi for Fisheye camera calibration model
Two constructor arguments in InputApiClient and FileResourceClient have been renamed from max_upload_retry_attemps, max_upload_retry_wait_time
to max_retry_attempts, max_retry_wait_time respectively.
The old camera calibration class will be deprecated in favour of the new classes
get_inputs_with_uuids, which can fetch inputs using only the input_uuid.annoutil has a new flag when fetching inputs, annoutil inputs --uuids <comma_separated_uuids>.lidars and lidars_sequence inputs now available through the client.add_annotation_type, which adds additional annotation types to be performed for an input.client.calibration.get_calibration() now properly deserializes calibration into SensorCalibrationEntry instead of keeping it as a dict.created timestamp when querying get_inputsget_annotation_typesinput_list_id replaced with annotation_types for all createable resources (Cameras, CamerasSeq, LidarsAndCameras, LidarsAndCamerasSeq).calibration_id now available for created inputs via the client.input.get_inputs method.client.project.create_batch method. Please contact Annotell's Professional Services
before using. More information available in the documentation.invalidate_inputs did not properly discard response content.input_list_id and project is not used simultaneously when creating inputsframe_id and relative_timestamp from lidars_and_camerasdataclasses to support python 3.6.client.lidar_and_cameras.create replaces client.create_inputs_point_cloud_with_imagesclient.cameras.create replaces client.upload_and_create_images_input_jobclient.annotations.get_annotations replaces client.download_annotationsget_calibration_data method. Does not affect
usage of the method in any way.deadline from projectupload_and_create_images_input_job to create_inputs_images.list_projects to get_projects.list_project_batches to get_project_batches.download_annotations. The previously optional argumnet request_id has been removed. Additionally, the return
signature is changed to return a list of annotations for each input, instead of a dict as before.get_inputs has changed. It now receives project (identifier, not numerical id anymore), as well as three optional parameters batch, external_ids and include_invalidated. Returns all inputs belonging to the project, with the option of filtering on batch, external ID and whether or not including invalidated inputs. The returned list of classes had additional fields describing which batch each input belongs to, as well as their status (created, processing, failed, invalidated).input_ids to input_internal_ids for method invalidate_inputs.dataclasses to support python 3.6.python-dateutil.count_inputs_for_external_ids, get_internal_ids_for_external_ids, mend_input_data, remove_inputs_from_input_list, list_input_lists, publish_batch, get_requests_for_request_ids, get_requests_for_input_lists, get_input_status, get_input_jobs_status, get_requests_for_project_id, get_datas_for_inputs_by_internal_ids and get_datas_for_inputs_by_external_ids have all been removed.README.md and instead link to new docs.InputBatch and InputBatch.lidar and camera calibration added.publish_batch which accepts project identifier and batch identifier and marks the batch as ready for annotation.lidar and camera calibration models. No other change in functionality.get_inputs which accepts a project ID or project identifier (external ID) and returns inputs connected to the project. invalidated filter parameter to optionally filter only invalidated inputs. Also exposed in annoutil as annoutil projects 1 --invalidated.invalidate_inputs now accepts annotell internal_ids (UUID) instead of Annotell specific input ids.dynamic_objects not includes both cuboids and cuboid_timespansproject and batch identifiers for input request.
Specifying project and batch adds input to specified batch.
When only sending project, inputs are added to the latest open batch for the project.input_list_id will be removed in the 0.4.x versionsub_sequence_id and optional settingssequence_idInputApiClient
by specifying values to the max_upload_retry_attempts and max_upload_retry_wait_time parameters.create_inputs_point_cloud_with_images in InputApiClient now takes an extra parameter: dryrun: bool.
If set to True all the validation checks will be run but no inputJob will be created, and
if it is set to False an inputJob will be created if the validation checks all pass.InputApiClient: count_inputs_for_external_ids.InputApiClient classCalibrationSpec from CalibratedSceneMetaData and SlamMetaData. Updated
so that create_calibration_data in InputApiClient only takes a CalibrationSpec
as parameter.Image and PointCloud containing filename and source. Consequently, images_to_source is removed from SourceSpecification.create_images_input_jobinvalidate_inputsremove_inputs_from_input_listget_datas_for_inputs_by_internal_ids and get_datas_for_inputs_by_external_ids can be used to get which Data are part of an Input, useful in order to check which images, lidar-files have been uploaded. Both are also available in the CLI via :$ annoutil inputs --get-datas <internal_ids>
$ annoutil inputs-externalid --get-datas <external_ids>
Kannala camera types. Whenever adding calibration for Kannala undistortion coefficients must also be added.auth parameterget_input_jobs_status now accepts lists of internal_ids and external_ids as arguments.FAQs
Kognic IO Client
We found that kognic-io demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.
Security News
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.