image

package

v0.10.0-beta Latest Latest Go to latest Published: Mar 12, 2024 License: MIT Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

README ¶

---
title: "Image"
lang: "en-US"
draft: false
description: "Learn about how to set up a VDP Image operator https://github.com/instill-ai/vdp"
---

The Image component is an operator that tODO.
It can carry out the following tasks:

- [Draw Classification](#draw-classification)
- [Draw Detection](#draw-detection)
- [Draw Keypoint](#draw-keypoint)
- [Draw Ocr](#draw-ocr)
- [Draw Instance Segmentation](#draw-instance-segmentation)
- [Draw Semantic Segmentation](#draw-semantic-segmentation)

## Release Stage

`Alpha`

## Configuration

The component configuration is defined and maintained [here](https://github.com/instill-ai/operator/blob/main/pkg/image/v0/config/definitions.json).

## Supported Tasks

### Draw Classification

| Input | Type | Description |
| :--- | --- | --- |
| task | string | `TASK_DRAW_CLASSIFICATION` |

### Draw Detection

| Input | Type | Description |
| :--- | --- | --- |
| task | string | `TASK_DRAW_DETECTION` |

### Draw Keypoint

| Input | Type | Description |
| :--- | --- | --- |
| task | string | `TASK_DRAW_KEYPOINT` |

### Draw Ocr

| Input | Type | Description |
| :--- | --- | --- |
| task | string | `TASK_DRAW_OCR` |

### Draw Instance Segmentation

| Input | Type | Description |
| :--- | --- | --- |
| task | string | `TASK_DRAW_INSTANCE_SEGMENTATION` |

### Draw Semantic Segmentation

| Input | Type | Description |
| :--- | --- | --- |
| task | string | `TASK_DRAW_SEMANTIC_SEGMENTATION` |

Documentation ¶

Overview ¶

TODO go:generate compogen readme --operator ./config ./README.mdx

Index ¶

Variables
func Init(logger *zap.Logger) base.IOperator
type BoundingBox
- func (b *BoundingBox) Size() int
type Execution
- func (e *Execution) Execute(inputs []*structpb.Struct) ([]*structpb.Struct, error)
type Keypoint
type Operator
- func (o *Operator) CreateExecution(defUID uuid.UUID, task string, config *structpb.Struct, logger *zap.Logger) (base.IExecution, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var IBMPlexSansRegular = []byte{} /* 175232 elements not displayed */

IBMPlexSansRegular is the font byte array

Functions ¶

func Init ¶

func Init(logger *zap.Logger) base.IOperator

Init initializes the operator

Types ¶

type BoundingBox ¶

type BoundingBox struct {
	Top    int
	Left   int
	Width  int
	Height int
}

BoundingBox holds the coordinates of a bounding box.

func (*BoundingBox) Size ¶

func (b *BoundingBox) Size() int

Size returns the area of the bounding box.

type Execution ¶

type Execution struct {
	base.Execution
}

Execution is the derived execution

func (*Execution) Execute ¶

func (e *Execution) Execute(inputs []*structpb.Struct) ([]*structpb.Struct, error)

Execute executes the derived execution

type Keypoint ¶

type Keypoint struct {
	// contains filtered or unexported fields
}

Keypoint holds the coordinates of a keypoint.

type Operator ¶

type Operator struct {
	base.Operator
}

Operator is the derived operator

func (*Operator) CreateExecution ¶

func (o *Operator) CreateExecution(defUID uuid.UUID, task string, config *structpb.Struct, logger *zap.Logger) (base.IExecution, error)

CreateExecution creates the derived execution

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL