Classes
-
module habitat
- module config
-
module core
-
module env
-
module embodied_task Implements tasks and measurements needed for training and benchmarking of
habitat.Agent
inside habitat.Env
.
- class Action An action that can be performed by an agent solving a task in environment.
For example for navigation task action classes will be:
MoveForwardAction, TurnLeftAction, TurnRightAction
. The action can
use Task
members to pass a state to another action, as well as keep
own state and reset when new episode starts.
- class EmbodiedTask Base class for embodied tasks.
EmbodiedTask
holds definition of
a task that agent needs to solve: action space, observation space,
measures, simulator usage. EmbodiedTask
has reset() and
step() methods that are called by Env
. EmbodiedTask
is the
one of main dimensions for the framework extension. Once new embodied task
is introduced implementation of EmbodiedTask
is a formal definition of
the task that opens opportunity for others to propose solutions and
include it into benchmark results.
- class Measure Represents a measure that provides measurement on top of environment
and task.
- class Measurements Represents a set of Measures, with each Measure being
identified through a unique id.
- class Metrics Dictionary containing measurements.
- class SimulatorTaskAction An
EmbodiedTask
action that is wrapping simulator action.
-
module dataset Implements dataset functionality to be used
habitat.EmbodiedTask
.
habitat.core.dataset
abstracts over a collection of
habitat.core.Episode
. Each episode consists of a single instantiation
of a habitat.Agent
inside habitat.Env
.
- class Dataset Base class for dataset specification.
- class Episode Base class for episode specification that includes initial position and
rotation of agent, scene id, episode.
- class EpisodeIterator Episode Iterator class that gives options for how a list of episodes
should be iterated.
-
module simulator
- class ActionSpaceConfiguration
- class AgentState
- class BumpSensor
- class DepthSensor
- class Observations Dictionary containing sensor observations
- class RGBSensor
- class SemanticSensor
- class Sensor Represents a sensor that provides data from the environment to agent.
- class SensorSuite Represents a set of sensors, with each sensor being identified
through a unique id.
- class ShortestPathPoint
- class Simulator Basic simulator class for habitat. New simulators to be added to habtiat
must derive from this class and implement the abstarct methods.
-
module registry Registry is central source of truth in Habitat.
- class Registry
-
module vector_env
- class ThreadedVectorEnv Provides same functionality as VectorEnv, the only difference
is it runs in a multi-thread setup inside a single process.
- class VectorEnv Vectorized environment which creates multiple processes where each
process runs its own environment. Main class for parallelization of
training and evaluation.
- class Agent Abstract class for defining agents which act inside core.env.Env.
- class Benchmark Benchmark for evaluating agents in environments.
- module config
-
module core
- module env
-
module embodied_task Implements tasks and measurements needed for training and benchmarking of
habitat.Agent
insidehabitat.Env
.- class Action An action that can be performed by an agent solving a task in environment.
For example for navigation task action classes will be:
MoveForwardAction, TurnLeftAction, TurnRightAction
. The action can useTask
members to pass a state to another action, as well as keep own state and reset when new episode starts. - class EmbodiedTask Base class for embodied tasks.
EmbodiedTask
holds definition of a task that agent needs to solve: action space, observation space, measures, simulator usage.EmbodiedTask
has reset() and step() methods that are called byEnv
.EmbodiedTask
is the one of main dimensions for the framework extension. Once new embodied task is introduced implementation ofEmbodiedTask
is a formal definition of the task that opens opportunity for others to propose solutions and include it into benchmark results. - class Measure Represents a measure that provides measurement on top of environment and task.
- class Measurements Represents a set of Measures, with each Measure being identified through a unique id.
- class Metrics Dictionary containing measurements.
- class SimulatorTaskAction An
EmbodiedTask
action that is wrapping simulator action.
- class Action An action that can be performed by an agent solving a task in environment.
For example for navigation task action classes will be:
-
module dataset Implements dataset functionality to be used
habitat.EmbodiedTask
.habitat.core.dataset
abstracts over a collection ofhabitat.core.Episode
. Each episode consists of a single instantiation of ahabitat.Agent
insidehabitat.Env
.- class Dataset Base class for dataset specification.
- class Episode Base class for episode specification that includes initial position and rotation of agent, scene id, episode.
- class EpisodeIterator Episode Iterator class that gives options for how a list of episodes should be iterated.
-
module simulator
- class ActionSpaceConfiguration
- class AgentState
- class BumpSensor
- class DepthSensor
- class Observations Dictionary containing sensor observations
- class RGBSensor
- class SemanticSensor
- class Sensor Represents a sensor that provides data from the environment to agent.
- class SensorSuite Represents a set of sensors, with each sensor being identified through a unique id.
- class ShortestPathPoint
- class Simulator Basic simulator class for habitat. New simulators to be added to habtiat must derive from this class and implement the abstarct methods.
-
module registry Registry is central source of truth in Habitat.
- class Registry
-
module vector_env
- class ThreadedVectorEnv Provides same functionality as VectorEnv, the only difference is it runs in a multi-thread setup inside a single process.
- class VectorEnv Vectorized environment which creates multiple processes where each process runs its own environment. Main class for parallelization of training and evaluation.
- class Agent Abstract class for defining agents which act inside core.env.Env.
- class Benchmark Benchmark for evaluating agents in environments.