@eyepop.ai/eyepop 0.23.0 → 1.0.0

package/README.md

@@ -253,9 +253,13 @@ By default, `EyePop.workerEndpoint().connect()` will cancel all currently runnin
 It is assumed that the caller _takes full control_ of that worker. To disable this behavior create an endpoint with 
 `EyePop.endpoint({stopJobs: false})`.
 
-## Data endpoint (experimental)
+## Data endpoint (PREVIEW)
 To support managing your own datasets and control model optimization v0.21.0 introduces `EyePop.dataEndpoint()`,
-an experimental pre-release which is subject to change. An officially supported version will be released with v1.0.0
+an experimental pre-release which is subject to change. An officially supported version will be released with v2.0.0
+
+## Composable Pops (PREVIEW)
+See [Composable Pops](composable-pops.md) for a preview of client side composability of pops, introduced in v1.0.0.
+
 
 
 

package/dist/eyepop.index.d.mts

@@ -314,17 +314,93 @@ declare enum ModelPrecisionType {
 }
 interface ModelInstanceDef {
     id?: string;
-    model_id: string;
-    dataset: string;
-    version: string | undefined;
-    format: ModelFormat;
-    type: ModelPrecisionType;
+    model_folder_url?: string;
+    model_id?: string;
+    dataset?: string;
+    version?: string;
+    format?: ModelFormat;
+    type?: ModelPrecisionType;
+}
+declare enum PopComponentType {
+    FORWARD = "forward",
+    INFERENCE = "inference",
+    TRACING = "tracing",
+    CONTOUR_FINDER = "contour_finder",
+    COMPONENT_FINDER = "component_finder"
+}
+declare enum ForwardOperatorType {
+    FULL = "full",
+    CROP = "crop",
+    CROP_WITH_FULL_FALLBACK = "crop_with_full_fallback"
+}
+interface PopCrop {
+    maxItems?: number;
+    boxPadding?: number;
+    orientationTargetAngle?: number;
+}
+interface PopForwardOperator {
+    type: ForwardOperatorType;
+    includeClasses?: string[];
+    crop?: PopCrop;
+}
+interface PopForward {
+    operator?: PopForwardOperator;
+    targets: PopComponent[];
+}
+interface BaseComponent {
+    type: PopComponentType;
+    forward?: PopForward;
+}
+interface ForwardComponent extends BaseComponent {
+}
+declare enum InferenceType {
+    IMAGE_CLASSIFICATION = "image_classification",
+    OBJECT_DETECTION = "object_detection",
+    KEY_POINTS = "key_points",
+    OCR = "ocr",
+    MESH = "mesh",
+    FEATURE_VECTOR = "feature_vector",
+    SEMANTIC_SEGMENTATION = "semantic_segmentation",
+    SEGMENTATION = "segmentation"
+}
+interface InferenceComponent extends BaseComponent {
+    inferenceTypes: InferenceType[];
+    hidden?: boolean;
+    modelUuid: string;
+    categoryName?: string;
+    confidenceThreshold?: number;
+    targetFps?: string;
+}
+interface TracingComponent extends BaseComponent {
+    reidModelUuid?: string;
+    maxAgeSeconds?: number;
+    iouThreshold?: number;
+    simThreshold?: number;
+}
+declare enum ContourType {
+    ALL_PIXELS = "all_pixels",
+    POLYGON = "polygon",
+    CONVEX_HULL = "convex_hull",
+    HOUGH_CIRCLES = "hough_circles",
+    CIRCLE = "circle",
+    TRIANGLE = "triangle",
+    RECTANGLE = "rectangle"
+}
+interface ContourFinderComponent extends BaseComponent {
+    contourType: ContourType;
+}
+interface ComponentFinderComponent extends BaseComponent {
+    dilate?: number;
+    erode?: number;
+    keepSource?: boolean;
+    componentClassLabel?: string;
+}
+type PopComponent = ForwardComponent | InferenceComponent | TracingComponent | ContourFinderComponent | ComponentFinderComponent;
+interface Pop {
+    components: PopComponent[];
+    postTransform?: string;
 }
 
-interface ModelRef {
-    id: string;
-    folderUrl: string;
-}
 declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     private _baseUrl;
     private _pipelineId;
@@ -339,10 +415,8 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     protected statusHandler404(statusCode: number): void;
     session(): Promise<WorkerSession>;
     popName(): string | null;
-    popComp(): string | null;
-    postTransform(): string | null;
-    changePopComp(popComp: string, modelRefs?: ModelRef[]): Promise<void>;
-    changePostTransform(postTransform: string | null): Promise<void>;
+    pop(): Pop | null;
+    changePop(pop: Pop): Promise<void>;
     popId(): string | null;
     onIngressEvent(handler: (event: IngressEvent) => void): WorkerEndpoint;
     liveIngress(stream: MediaStream): Promise<LiveMedia>;
@@ -357,7 +431,7 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     private jobDone;
     private jobStatus;
     protected reconnect(): Promise<WorkerEndpoint>;
-    private startPopLessPipeline;
+    private startTransientPipeline;
     manifest(): Promise<SourcesEntry[]>;
     models(): Promise<ModelInstanceDef[]>;
     changeManifest(manifests: SourcesEntry[]): Promise<void>;
@@ -672,4 +746,4 @@ declare namespace EyePop {
     function dataEndpoint(opts?: DataOptions): DataEndpoint;
 }
 
-export { AbstractJob, type Annotation, AnnotationType, type Asset, AssetStatus, type Auth0Options, type Authentication, type Box, type ChangeEvent, ChangeType, type Contour, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetUpdate, type DatasetVersion, Endpoint, EndpointState, EyePop, type FileSource, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type Mask, type Model, type ModelCreate, ModelFormat, type ModelInstanceDef, ModelPrecisionType, ModelStatus, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type Point2d, type Point3d, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedLabel, type PredictedMesh, type PredictedObject, type Prediction, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamSource, type StreamTime, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };
+export { AbstractJob, type Annotation, AnnotationType, type Asset, AssetStatus, type Auth0Options, type Authentication, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type Contour, type ContourFinderComponent, ContourType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetUpdate, type DatasetVersion, Endpoint, EndpointState, EyePop, type FileSource, type ForwardComponent, ForwardOperatorType, type InferenceComponent, InferenceType, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type Mask, type Model, type ModelCreate, ModelFormat, type ModelInstanceDef, ModelPrecisionType, ModelStatus, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedLabel, type PredictedMesh, type PredictedObject, type Prediction, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamSource, type StreamTime, type TracingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };

package/dist/eyepop.index.d.ts

@@ -314,17 +314,93 @@ declare enum ModelPrecisionType {
 }
 interface ModelInstanceDef {
     id?: string;
-    model_id: string;
-    dataset: string;
-    version: string | undefined;
-    format: ModelFormat;
-    type: ModelPrecisionType;
+    model_folder_url?: string;
+    model_id?: string;
+    dataset?: string;
+    version?: string;
+    format?: ModelFormat;
+    type?: ModelPrecisionType;
+}
+declare enum PopComponentType {
+    FORWARD = "forward",
+    INFERENCE = "inference",
+    TRACING = "tracing",
+    CONTOUR_FINDER = "contour_finder",
+    COMPONENT_FINDER = "component_finder"
+}
+declare enum ForwardOperatorType {
+    FULL = "full",
+    CROP = "crop",
+    CROP_WITH_FULL_FALLBACK = "crop_with_full_fallback"
+}
+interface PopCrop {
+    maxItems?: number;
+    boxPadding?: number;
+    orientationTargetAngle?: number;
+}
+interface PopForwardOperator {
+    type: ForwardOperatorType;
+    includeClasses?: string[];
+    crop?: PopCrop;
+}
+interface PopForward {
+    operator?: PopForwardOperator;
+    targets: PopComponent[];
+}
+interface BaseComponent {
+    type: PopComponentType;
+    forward?: PopForward;
+}
+interface ForwardComponent extends BaseComponent {
+}
+declare enum InferenceType {
+    IMAGE_CLASSIFICATION = "image_classification",
+    OBJECT_DETECTION = "object_detection",
+    KEY_POINTS = "key_points",
+    OCR = "ocr",
+    MESH = "mesh",
+    FEATURE_VECTOR = "feature_vector",
+    SEMANTIC_SEGMENTATION = "semantic_segmentation",
+    SEGMENTATION = "segmentation"
+}
+interface InferenceComponent extends BaseComponent {
+    inferenceTypes: InferenceType[];
+    hidden?: boolean;
+    modelUuid: string;
+    categoryName?: string;
+    confidenceThreshold?: number;
+    targetFps?: string;
+}
+interface TracingComponent extends BaseComponent {
+    reidModelUuid?: string;
+    maxAgeSeconds?: number;
+    iouThreshold?: number;
+    simThreshold?: number;
+}
+declare enum ContourType {
+    ALL_PIXELS = "all_pixels",
+    POLYGON = "polygon",
+    CONVEX_HULL = "convex_hull",
+    HOUGH_CIRCLES = "hough_circles",
+    CIRCLE = "circle",
+    TRIANGLE = "triangle",
+    RECTANGLE = "rectangle"
+}
+interface ContourFinderComponent extends BaseComponent {
+    contourType: ContourType;
+}
+interface ComponentFinderComponent extends BaseComponent {
+    dilate?: number;
+    erode?: number;
+    keepSource?: boolean;
+    componentClassLabel?: string;
+}
+type PopComponent = ForwardComponent | InferenceComponent | TracingComponent | ContourFinderComponent | ComponentFinderComponent;
+interface Pop {
+    components: PopComponent[];
+    postTransform?: string;
 }
 
-interface ModelRef {
-    id: string;
-    folderUrl: string;
-}
 declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     private _baseUrl;
     private _pipelineId;
@@ -339,10 +415,8 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     protected statusHandler404(statusCode: number): void;
     session(): Promise<WorkerSession>;
     popName(): string | null;
-    popComp(): string | null;
-    postTransform(): string | null;
-    changePopComp(popComp: string, modelRefs?: ModelRef[]): Promise<void>;
-    changePostTransform(postTransform: string | null): Promise<void>;
+    pop(): Pop | null;
+    changePop(pop: Pop): Promise<void>;
     popId(): string | null;
     onIngressEvent(handler: (event: IngressEvent) => void): WorkerEndpoint;
     liveIngress(stream: MediaStream): Promise<LiveMedia>;
@@ -357,7 +431,7 @@ declare class WorkerEndpoint extends Endpoint<WorkerEndpoint> {
     private jobDone;
     private jobStatus;
     protected reconnect(): Promise<WorkerEndpoint>;
-    private startPopLessPipeline;
+    private startTransientPipeline;
     manifest(): Promise<SourcesEntry[]>;
     models(): Promise<ModelInstanceDef[]>;
     changeManifest(manifests: SourcesEntry[]): Promise<void>;
@@ -672,4 +746,4 @@ declare namespace EyePop {
     function dataEndpoint(opts?: DataOptions): DataEndpoint;
 }
 
-export { AbstractJob, type Annotation, AnnotationType, type Asset, AssetStatus, type Auth0Options, type Authentication, type Box, type ChangeEvent, ChangeType, type Contour, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetUpdate, type DatasetVersion, Endpoint, EndpointState, EyePop, type FileSource, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type Mask, type Model, type ModelCreate, ModelFormat, type ModelInstanceDef, ModelPrecisionType, ModelStatus, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type Point2d, type Point3d, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedLabel, type PredictedMesh, type PredictedObject, type Prediction, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamSource, type StreamTime, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };
+export { AbstractJob, type Annotation, AnnotationType, type Asset, AssetStatus, type Auth0Options, type Authentication, type BaseComponent, type Box, type ChangeEvent, ChangeType, type ComponentFinderComponent, type Contour, type ContourFinderComponent, ContourType, DataEndpoint, type DataOptions, type DataSession, type Dataset, type DatasetCreate, type DatasetUpdate, type DatasetVersion, Endpoint, EndpointState, EyePop, type FileSource, type ForwardComponent, ForwardOperatorType, type InferenceComponent, InferenceType, type IngressEvent, type LiveMedia, type LiveSource, LoadFromJob, LoadLiveIngressJob, type Mask, type Model, type ModelCreate, ModelFormat, type ModelInstanceDef, ModelPrecisionType, ModelStatus, ModelType, type ModelUpdate, type OAuth2Auth, type OnChangeEvent, type Options, type PathSource, type Point2d, type Point3d, type Pop, type PopComponent, PopComponentType, type PopCrop, type PopForward, type PopForwardOperator, type PredictedClass, type PredictedKeyPoint, type PredictedKeyPoints, type PredictedLabel, type PredictedMesh, type PredictedObject, type Prediction, type ResultStream, type Roi, type SecretKeyAuth, Semaphore, type Session, type SessionAuth, type Source, type SourceParams, type SourcesEntry, Stream, type StreamSource, type StreamTime, type TracingComponent, TranscodeMode, TransientPopId, UploadJob, type UrlSource, UserReview, WebrtcBase, WebrtcWhep, WebrtcWhip, WorkerEndpoint, type WorkerOptions, type WorkerSession, EyePop as default };

package/dist/eyepop.index.js

@@ -8660,16 +8660,20 @@ __export(eyepop_exports, {
   AnnotationType: () => AnnotationType,
   AssetStatus: () => AssetStatus,
   ChangeType: () => ChangeType,
+  ContourType: () => ContourType,
   DataEndpoint: () => DataEndpoint,
   Endpoint: () => Endpoint,
   EndpointState: () => EndpointState,
   EyePop: () => EyePop,
+  ForwardOperatorType: () => ForwardOperatorType,
+  InferenceType: () => InferenceType,
   LoadFromJob: () => LoadFromJob,
   LoadLiveIngressJob: () => LoadLiveIngressJob,
   ModelFormat: () => ModelFormat,
   ModelPrecisionType: () => ModelPrecisionType,
   ModelStatus: () => ModelStatus,
   ModelType: () => ModelType,
+  PopComponentType: () => PopComponentType,
   Semaphore: () => Semaphore,
   Stream: () => Stream,
   TranscodeMode: () => TranscodeMode,
@@ -10108,40 +10112,30 @@ var WorkerEndpoint = class extends Endpoint {
   popName() {
     return this._popName;
   }
-  popComp() {
+  pop() {
     if (this._pipeline) {
-      return this._pipeline.inferPipeline;
+      return this._pipeline.pop || null;
     } else {
       return null;
     }
   }
-  postTransform() {
-    if (this._pipeline) {
-      return this._pipeline.postTransform;
-    } else {
-      return null;
-    }
-  }
-  async changePopComp(popComp, modelRefs = []) {
+  async changePop(pop) {
     const client = this._client;
     const baseUrl = this._baseUrl;
     if (!baseUrl || !client) {
       return Promise.reject("endpoint not connected, use connect() before changePopComp()");
     }
-    const body = {
-      "pipeline": popComp,
-      "modelRefs": modelRefs
-    };
     let response = await this.fetchWithRetry(async () => {
       const session = await this.session();
       let headers = {
         "Authorization": `Bearer ${session.accessToken}`,
         "Content-Type": "application/json"
       };
-      const patch_url = `${session.baseUrl}/pipelines/${session.pipelineId}/inferencePipeline`;
+      const patch_url = `${session.baseUrl}/pipelines/${session.pipelineId}/pop`;
+      this._requestLogger.debug("before PATCH %s - %s", patch_url, JSON.stringify(pop));
       return client.fetch(patch_url, {
         method: "PATCH",
-        body: JSON.stringify(body),
+        body: JSON.stringify(pop),
         headers
       });
     });
@@ -10150,40 +10144,9 @@ var WorkerEndpoint = class extends Endpoint {
       console.error(message);
       return Promise.reject(`Unexpected status ${response.status}: ${message}`);
     }
+    this._requestLogger.debug("after PATCH pop");
     if (this._pipeline) {
-      this._pipeline.inferPipeline = popComp;
-      this._pipeline.modelRefs = modelRefs;
-    }
-  }
-  async changePostTransform(postTransform) {
-    const client = this._client;
-    const baseUrl = this._baseUrl;
-    if (!baseUrl || !client) {
-      return Promise.reject("endpoint not connected, use connect() before changePopComp()");
-    }
-    postTransform = postTransform ? postTransform : null;
-    const body = {
-      "transform": postTransform
-    };
-    let response = await this.fetchWithRetry(async () => {
-      const session = await this.session();
-      let headers = {
-        "Authorization": `Bearer ${session.accessToken}`,
-        "Content-Type": "application/json"
-      };
-      const patch_url = `${session.baseUrl}/pipelines/${session.pipelineId}/postTransform`;
-      return client.fetch(patch_url, {
-        method: "PATCH",
-        body: JSON.stringify(body),
-        headers
-      });
-    });
-    if (response.status != 204) {
-      const message = await response.text();
-      return Promise.reject(`Unexpected status ${response.status}: ${message}`);
-    }
-    if (this._pipeline) {
-      this._pipeline.postTransform = postTransform;
+      this._pipeline.pop = pop;
     }
   }
   popId() {
@@ -10448,7 +10411,7 @@ var WorkerEndpoint = class extends Endpoint {
         }
       }
       if (this.options().popId == "transient" /* Transient */) {
-        this._pipelineId = await this.startPopLessPipeline();
+        this._pipelineId = await this.startTransientPipeline();
         this._popName = this.options().popId || null;
       } else {
         this._pipelineId = config.pipeline_id;
@@ -10496,39 +10459,23 @@ var WorkerEndpoint = class extends Endpoint {
     this.updateState();
     return Promise.resolve(this);
   }
-  async startPopLessPipeline() {
+  async startTransientPipeline() {
     const client = this._client;
     const baseUrl = this._baseUrl;
     const sandboxId = this._sandboxId;
     if (client == null || baseUrl == null) {
       return Promise.reject("endpoint not initialized");
     }
-    let pipeline;
-    if (this._pipeline) {
-      pipeline = this._pipeline.inferPipeline;
-    } else {
-      pipeline = "identity";
-    }
-    let postTransform;
-    if (this._pipeline && this._pipeline.postTransform) {
-      postTransform = this._pipeline.postTransform;
+    let pop;
+    if (this._pipeline && this._pipeline.pop) {
+      pop = this._pipeline.pop;
     } else {
-      postTransform = null;
-    }
-    let modelRefs;
-    if (this._pipeline && this._pipeline.modelRefs) {
-      modelRefs = this._pipeline.modelRefs;
-    } else {
-      modelRefs = [];
+      pop = {
+        components: []
+      };
     }
     const body = {
-      "inferPipelineDef": {
-        "pipeline": pipeline,
-        "modelRefs": modelRefs
-      },
-      "postTransformDef": {
-        "transform": postTransform
-      },
+      "pop": pop,
       "source": {
         "sourceType": "NONE"
       },
@@ -11268,6 +11215,41 @@ var ModelPrecisionType = /* @__PURE__ */ ((ModelPrecisionType2) => {
   ModelPrecisionType2["uint8"] = "uint8";
   return ModelPrecisionType2;
 })(ModelPrecisionType || {});
+var PopComponentType = /* @__PURE__ */ ((PopComponentType2) => {
+  PopComponentType2["FORWARD"] = "forward";
+  PopComponentType2["INFERENCE"] = "inference";
+  PopComponentType2["TRACING"] = "tracing";
+  PopComponentType2["CONTOUR_FINDER"] = "contour_finder";
+  PopComponentType2["COMPONENT_FINDER"] = "component_finder";
+  return PopComponentType2;
+})(PopComponentType || {});
+var ForwardOperatorType = /* @__PURE__ */ ((ForwardOperatorType2) => {
+  ForwardOperatorType2["FULL"] = "full";
+  ForwardOperatorType2["CROP"] = "crop";
+  ForwardOperatorType2["CROP_WITH_FULL_FALLBACK"] = "crop_with_full_fallback";
+  return ForwardOperatorType2;
+})(ForwardOperatorType || {});
+var InferenceType = /* @__PURE__ */ ((InferenceType2) => {
+  InferenceType2["IMAGE_CLASSIFICATION"] = "image_classification";
+  InferenceType2["OBJECT_DETECTION"] = "object_detection";
+  InferenceType2["KEY_POINTS"] = "key_points";
+  InferenceType2["OCR"] = "ocr";
+  InferenceType2["MESH"] = "mesh";
+  InferenceType2["FEATURE_VECTOR"] = "feature_vector";
+  InferenceType2["SEMANTIC_SEGMENTATION"] = "semantic_segmentation";
+  InferenceType2["SEGMENTATION"] = "segmentation";
+  return InferenceType2;
+})(InferenceType || {});
+var ContourType = /* @__PURE__ */ ((ContourType2) => {
+  ContourType2["ALL_PIXELS"] = "all_pixels";
+  ContourType2["POLYGON"] = "polygon";
+  ContourType2["CONVEX_HULL"] = "convex_hull";
+  ContourType2["HOUGH_CIRCLES"] = "hough_circles";
+  ContourType2["CIRCLE"] = "circle";
+  ContourType2["TRIANGLE"] = "triangle";
+  ContourType2["RECTANGLE"] = "rectangle";
+  return ContourType2;
+})(ContourType || {});
 
 // index.ts
 var readEnv = (env) => {
@@ -11369,16 +11351,20 @@ var eyepop_default = EyePop;
   AnnotationType,
   AssetStatus,
   ChangeType,
+  ContourType,
   DataEndpoint,
   Endpoint,
   EndpointState,
   EyePop,
+  ForwardOperatorType,
+  InferenceType,
   LoadFromJob,
   LoadLiveIngressJob,
   ModelFormat,
   ModelPrecisionType,
   ModelStatus,
   ModelType,
+  PopComponentType,
   Semaphore,
   Stream,
   TranscodeMode,