Gonkumentation!
Gonk is a backend for building and versioning deep learning datasets. Its goal is to do the heavy lifting for storage, validation, and approval workflows to make labeling high-quality datasets more efficient.
About Gonk
Features
Works with any file type
Strongly defined annotation formats using JSON Schema
Complete dataset version history through event sourcing
Change approval to enable collaboration with untrusted third parties
Point-in-time release tagging
Reproducible dataset releases
Cloning the full dataset history
API Workflow
Create a dataset
Design an annotation format in JSON Schema <https://json-schema.org/learn/getting-started-step-by-step.html>
Add your schema to the dataset
Add objects to the dataset
Annotate objects
Approve or reject changes
Generate a release
Gonk API Docs
- gonk-api
- Commands
- API Endpoints
/datasets/datasets/<dataset_name>/schemas/datasets/<dataset_name>/schemas/<schema_name>/datasets/<dataset_name>/schemas/<schema_status>/datasets/<dataset_name>/schemas/<schema_name>/<schema_version>/datasets/<dataset_name>/owners/datasets/<dataset_name>/owners/<user>/datasets/<dataset_name>/objects/datasets/<dataset_name>/objects/<object_uuid>/datasets/<dataset_name>/objects/<object_status>/datasets/<dataset_name>/objects/<object_uuid>/<object_version>/datasets/<dataset_name>/events/datasets/<dataset_name>/events/<event_uuid>/accept/datasets/<dataset_name>/events/<event_uuid>/reject/datasets/<dataset_name>/annotations/datasets/<dataset_name>/annotations/<annotation_uuid>/datasets/<dataset_name>/annotations/<annotation_status>/datasets/<dataset_name>/annotations/<annotation_uuid>/<annotation_version>
Module Docs
Core
- gonk.core.interfaces
- gonk.core.events
ActionTDecisionTOwnerActionTHashTypeTIdentifierObjectAnnotationEventObjectEventObjectCreateEventObjectUpdateEventObjectDeleteEventAnnotationEventAnnotationCreateEventAnnotationUpdateEventAnnotationDeleteEventReviewEventReviewAcceptEventReviewRejectEventOwnerEventOwnerAddEventOwnerRemoveEvent
- gonk.core.integrity
- gonk.core.validators
- gonk.core.exceptions