# default_exp docs.input_output

Input/Output Types

Ipyannotator uses a pair of Input/Output to configure its API. The pair of Input/Output provides a simple and flexible way to write and combine annotators, making it easier users to customize the Ipyannotator API to their needs.

The current page explain which pairs are available.

Generic Annotation

class InputImage[source]

InputImage(image_dir:str='pics', image_width:int=100, image_height:int=100, fit_canvas:bool=False) :: Input

image_dir: string Directory of the image

image_width: int Width of the image

image_height: int Height of the image

fit_canvas: bool Ignores the image size and fit image on the canvas size

class NoOutput[source]

NoOutput() :: Output

Explore the data without worring about which type of data it's wanted to output

Image classification

class InputImage[source]

InputImage(image_dir:str='pics', image_width:int=100, image_height:int=100, fit_canvas:bool=False) :: Input

image_dir: string Directory of the image

image_width: int Width of the image

image_height: int Height of the image

fit_canvas: bool Ignores the image size and fit image on the canvas size

class OutputImageLabel[source]

OutputImageLabel(label_dir=None, label_width=50, label_height=50) :: Output

Configures the image output.

If no label_dir is specified, it generates randomized one.

Capture Annotator

class InputImage[source]

InputImage(image_dir:str='pics', image_width:int=100, image_height:int=100, fit_canvas:bool=False) :: Input

image_dir: string Directory of the image

image_width: int Width of the image

image_height: int Height of the image

fit_canvas: bool Ignores the image size and fit image on the canvas size

class OutputGridBox[source]

OutputGridBox() :: Output

Configures the capture annotator

Bounding Box image annotation

class InputImage[source]

InputImage(image_dir:str='pics', image_width:int=100, image_height:int=100, fit_canvas:bool=False) :: Input

image_dir: string Directory of the image

image_width: int Width of the image

image_height: int Height of the image

fit_canvas: bool Ignores the image size and fit image on the canvas size

class OutputImageBbox[source]

OutputImageBbox(classes:List[str]=None) :: Output

classes: List[str] Define the classes of objects available to be classified

Bounding box video annotator

class InputImage[source]

InputImage(image_dir:str='pics', image_width:int=100, image_height:int=100, fit_canvas:bool=False) :: Input

image_dir: string Directory of the image

image_width: int Width of the image

image_height: int Height of the image

fit_canvas: bool Ignores the image size and fit image on the canvas size

class OutputVideoBbox[source]

OutputVideoBbox(*args, **kwargs) :: OutputImageBbox

Specialization of the OutputImageBbox.

classes: List[str] Define the classes of objects available to be classified

previous

Bbox video annotator

next

API