fiftyone.server.query¶

FiftyOne Server queries

Copyright 2017-2022, Voxel51, Inc.
voxel51.com

Classes:

`AppConfig`(color_by, color_pool, colorscale, …)
`BrainRun`(key, version, NoneType], timestamp, …)
`BrainRunConfig`(cls, embeddings_field, …)
`ColorBy`	An enumeration.
`Dataset`(id, name, created_at, NoneType], …)
`EvaluationRun`(key, version, NoneType], …)
`EvaluationRunConfig`(cls, gt_field, …)
`KeypointSkeleton`(labels, NoneType], edges)
`MediaType`	An enumeration.
`NamedKeypointSkeleton`(labels, NoneType], …)
`NamedTargets`(name, targets)
`Query`()
`Run`(key, version, NoneType], timestamp, …)
`RunConfig`(cls)
`SampleField`(ftype, path, subfield, …)
`SidebarGroup`(name, paths)
`Target`(target, value)

Functions:

serialize_dataset(dataset, view)

class fiftyone.server.query.MediaType¶

Bases: enum.Enum

An enumeration.

Attributes:

`image`
`video`

image = 'image'¶

video = 'video'¶

class fiftyone.server.query.Target(target: int, value: str)¶

Bases: object

Attributes:

`fiftyone.server.query.Target.target`
`fiftyone.server.query.Target.value`

target: int = None¶

value: str = None¶

class fiftyone.server.query.NamedTargets(name: str, targets: List[fiftyone.server.query.Target])¶

Bases: object

Attributes:

`fiftyone.server.query.NamedTargets.name`
`fiftyone.server.query.NamedTargets.targets`

name: str = None¶

targets: t.List[Target] = None¶

class fiftyone.server.query.SampleField(ftype: str, path: str, subfield: Union[str, NoneType], embedded_doc_type: Union[str, NoneType], db_field: Union[str, NoneType])¶

Bases: object

Attributes:

`fiftyone.server.query.SampleField.db_field`
`fiftyone.server.query.SampleField.embedded_doc_type`
`fiftyone.server.query.SampleField.ftype`
`fiftyone.server.query.SampleField.path`
`fiftyone.server.query.SampleField.subfield`

ftype: str = None¶

path: str = None¶

subfield: t.Optional[str] = None¶

embedded_doc_type: t.Optional[str] = None¶

db_field: t.Optional[str] = None¶

class fiftyone.server.query.RunConfig(cls: str)¶

Bases: object

Attributes:

fiftyone.server.query.RunConfig.cls

cls: str = None¶

class fiftyone.server.query.Run(key: str, version: Union[str, NoneType], timestamp: Union[datetime.datetime, NoneType], config: Union[fiftyone.server.query.RunConfig, NoneType], view_stages: Union[List[str], NoneType])¶

Bases: object

Attributes:

`fiftyone.server.query.Run.config`
`fiftyone.server.query.Run.key`
`fiftyone.server.query.Run.timestamp`
`fiftyone.server.query.Run.version`
`fiftyone.server.query.Run.view_stages`

key: str = None¶

version: t.Optional[str] = None¶

timestamp: t.Optional[datetime] = None¶

config: t.Optional[RunConfig] = None¶

view_stages: t.Optional[t.List[str]] = None¶

class fiftyone.server.query.BrainRunConfig(cls: str, embeddings_field: Union[str, NoneType], method: Union[str, NoneType], patches_field: Union[str, NoneType])¶

Bases: fiftyone.server.query.RunConfig

Attributes:

`fiftyone.server.query.BrainRunConfig.embeddings_field`
`fiftyone.server.query.BrainRunConfig.method`
`fiftyone.server.query.BrainRunConfig.patches_field`

embeddings_field: t.Optional[str] = None¶

method: t.Optional[str] = None¶

patches_field: t.Optional[str] = None¶

class fiftyone.server.query.BrainRun(key: str, version: Union[str, NoneType], timestamp: Union[datetime.datetime, NoneType], config: Union[fiftyone.server.query.BrainRunConfig, NoneType], view_stages: Union[List[str], NoneType])¶

Bases: fiftyone.server.query.Run

Attributes:

fiftyone.server.query.BrainRun.config

config: t.Optional[BrainRunConfig] = None¶

class fiftyone.server.query.EvaluationRunConfig(cls: str, gt_field: Union[str, NoneType], pred_field: Union[str, NoneType], method: Union[str, NoneType])¶

Bases: fiftyone.server.query.RunConfig

Attributes:

`fiftyone.server.query.EvaluationRunConfig.gt_field`
`fiftyone.server.query.EvaluationRunConfig.method`
`fiftyone.server.query.EvaluationRunConfig.pred_field`

gt_field: t.Optional[str] = None¶

pred_field: t.Optional[str] = None¶

method: t.Optional[str] = None¶

class fiftyone.server.query.EvaluationRun(key: str, version: Union[str, NoneType], timestamp: Union[datetime.datetime, NoneType], config: Union[fiftyone.server.query.EvaluationRunConfig, NoneType], view_stages: Union[List[str], NoneType])¶

Bases: fiftyone.server.query.Run

Attributes:

fiftyone.server.query.EvaluationRun.config

config: t.Optional[EvaluationRunConfig] = None¶

class fiftyone.server.query.SidebarGroup(name: str, paths: List[str])¶

Bases: object

Attributes:

`fiftyone.server.query.SidebarGroup.name`
`fiftyone.server.query.SidebarGroup.paths`

name: str = None¶

paths: t.List[str] = None¶

class fiftyone.server.query.KeypointSkeleton(labels: Union[List[str], NoneType], edges: List[List[int]])¶

Bases: object

Attributes:

`fiftyone.server.query.KeypointSkeleton.edges`
`fiftyone.server.query.KeypointSkeleton.labels`

labels: t.Optional[t.List[str]] = None¶

edges: t.List[t.List[int]] = None¶

class fiftyone.server.query.NamedKeypointSkeleton(labels: Union[List[str], NoneType], edges: List[List[int]], name: str)¶

Bases: fiftyone.server.query.KeypointSkeleton

Attributes:

fiftyone.server.query.NamedKeypointSkeleton.name

name: str = None¶

class fiftyone.server.query.Dataset(id: <function NewType.<locals>.new_type at 0x7f62c195c3a0>, name: str, created_at: Union[datetime.date, NoneType], last_loaded_at: Union[datetime.datetime, NoneType], persistent: bool, media_type: Union[fiftyone.server.query.MediaType, NoneType], mask_targets: List[fiftyone.server.query.NamedTargets], default_mask_targets: Union[List[fiftyone.server.query.Target], NoneType], sample_fields: List[fiftyone.server.query.SampleField], frame_fields: List[fiftyone.server.query.SampleField], brain_methods: List[fiftyone.server.query.BrainRun], evaluations: List[fiftyone.server.query.EvaluationRun], app_sidebar_groups: Union[List[fiftyone.server.query.SidebarGroup], NoneType], version: Union[str, NoneType], view_cls: Union[str, NoneType], default_skeleton: Union[fiftyone.server.query.KeypointSkeleton, NoneType], skeletons: List[fiftyone.server.query.NamedKeypointSkeleton])¶

Bases: fiftyone.server.mixins.HasCollection

Attributes:

`fiftyone.server.query.Dataset.app_sidebar_groups`
`fiftyone.server.query.Dataset.brain_methods`
`fiftyone.server.query.Dataset.created_at`
`fiftyone.server.query.Dataset.default_mask_targets`
`fiftyone.server.query.Dataset.default_skeleton`
`fiftyone.server.query.Dataset.evaluations`
`fiftyone.server.query.Dataset.frame_fields`
`fiftyone.server.query.Dataset.id`
`fiftyone.server.query.Dataset.last_loaded_at`
`fiftyone.server.query.Dataset.mask_targets`
`fiftyone.server.query.Dataset.media_type`
`fiftyone.server.query.Dataset.name`
`fiftyone.server.query.Dataset.persistent`
`fiftyone.server.query.Dataset.sample_fields`
`fiftyone.server.query.Dataset.skeletons`
`fiftyone.server.query.Dataset.version`
`fiftyone.server.query.Dataset.view_cls`

Methods:

`get_collection_name`()
`modifier`(doc)
`resolver`(name, view, info)

id: gql.ID = None¶

name: str = None¶

created_at: t.Optional[date] = None¶

last_loaded_at: t.Optional[datetime] = None¶

persistent: bool = None¶

media_type: t.Optional[MediaType] = None¶

mask_targets: t.List[NamedTargets] = None¶

default_mask_targets: t.Optional[t.List[Target]] = None¶

sample_fields: t.List[SampleField] = None¶

frame_fields: t.List[SampleField] = None¶

brain_methods: t.List[BrainRun] = None¶

evaluations: t.List[EvaluationRun] = None¶

app_sidebar_groups: t.Optional[t.List[SidebarGroup]] = None¶

version: t.Optional[str] = None¶

view_cls: t.Optional[str] = None¶

default_skeleton: t.Optional[KeypointSkeleton] = None¶

skeletons: t.List[NamedKeypointSkeleton] = None¶

static get_collection_name() → str¶

static modifier(doc: dict) → dict¶

async classmethod resolver(name: str, view: Optional[<strawberry.custom_scalar.ScalarWrapper object at 0x7f62c3715220>], info: strawberry.types.info.Info[fiftyone.server.data.Context, NoneType][fiftyone.server.data.Context, None]) → Optional[fiftyone.server.query.Dataset]¶

class fiftyone.server.query.ColorBy¶

Bases: enum.Enum

An enumeration.

Attributes:

`field`
`instance`
`label`

field = 'field'¶

instance = 'instance'¶

label = 'label'¶

class fiftyone.server.query.AppConfig(color_by: fiftyone.server.query.ColorBy, color_pool: List[str], colorscale: str, grid_zoom: int, loop_videos: bool, notebook_height: int, show_confidence: bool, show_index: bool, show_label: bool, show_skeletons: bool, show_tooltip: bool, timezone: Union[str, NoneType], use_frame_number: bool)¶

Bases: object

Attributes:

`fiftyone.server.query.AppConfig.color_by`
`fiftyone.server.query.AppConfig.color_pool`
`fiftyone.server.query.AppConfig.colorscale`
`fiftyone.server.query.AppConfig.grid_zoom`
`fiftyone.server.query.AppConfig.loop_videos`
`fiftyone.server.query.AppConfig.notebook_height`
`fiftyone.server.query.AppConfig.show_confidence`
`fiftyone.server.query.AppConfig.show_index`
`fiftyone.server.query.AppConfig.show_label`
`fiftyone.server.query.AppConfig.show_skeletons`
`fiftyone.server.query.AppConfig.show_tooltip`
`fiftyone.server.query.AppConfig.timezone`
`fiftyone.server.query.AppConfig.use_frame_number`

color_by: ColorBy = None¶

color_pool: t.List[str] = None¶

colorscale: str = None¶

grid_zoom: int = None¶

loop_videos: bool = None¶

notebook_height: int = None¶

show_confidence: bool = None¶

show_index: bool = None¶

show_label: bool = None¶

show_skeletons: bool = None¶

show_tooltip: bool = None¶

timezone: t.Optional[str] = None¶

use_frame_number: bool = None¶

class fiftyone.server.query.Query¶

Bases: object

Methods:

`colorscale`()
`config`()
`context`()
`dataset`(name, view, info)
`datasets`([first, after, info])
`dev`()
`do_not_track`()
`teams_submission`()
`uid`()
`version`()

colorscale() → Optional[List[List[int]]]¶

config() → fiftyone.server.query.AppConfig¶

context() → str¶

dev() → bool¶

do_not_track() → bool¶

async classmethod dataset(name: str, view: Optional[<strawberry.custom_scalar.ScalarWrapper object at 0x7f62c3715220>], info: strawberry.types.info.Info[fiftyone.server.data.Context, NoneType][fiftyone.server.data.Context, None]) → Optional[fiftyone.server.query.Dataset]¶

async datasets(first: Optional[int] = 200, after: Optional[str] = None, info: strawberry.types.info.Info[fiftyone.server.data.Context, NoneType][fiftyone.server.data.Context, None] = None)¶

teams_submission() → bool¶

uid() → str¶

version() → str¶

fiftyone.server.query.serialize_dataset(dataset: fiftyone.core.dataset.Dataset, view: fiftyone.core.view.DatasetView) → Dict¶