rlmesh.hpp
RLMesh C++17 API.
Experimental
#include <rlmesh.hpp>Classes
- SpanExperimentalA borrowed contiguous view.
- RuntimeErrorExperimental
RuntimeError: misuse and local refusals. - RLMeshExceptionExperimental
RLMeshException: an internal or server-side failure. - ProtocolExceptionExperimental
ProtocolException: generation mismatch, refused edition, failed handshake, malformed message. - EnvironmentExceptionExperimental
EnvironmentException: the env reported a failure. - RecoverableEnvironmentExceptionExperimental
RecoverableEnvironmentException: the request failed, the session stays usable. - ModelExceptionExperimental
ModelException: the model reported a failure. - ValueErrorExperimental
ValueError: an invalid argument value, address or options field. - AdapterResolutionErrorExperimental
AdapterResolutionError: adapters cannot bridge env and model. - TypeErrorExperimental
TypeError: the wrong kind of value or object. - OSErrorExperimental
OSError: a filesystem failure. - ConnectionErrorExperimental
ConnectionError(anOSError): a transport failure. - TimeoutErrorExperimental
TimeoutError(anOSError): a connect or request deadline. - ext::CancelledErrorExperimentalCancellation (the
KeyboardInterrupterror class). - ext::DlpackDeleterExperimental
- ext::CancelTokenExperimental
- ToDlpackOptionsExperimental
- TensorExperimental
- ValueExperimental
- MetadataExperimental
- OptionalListExperimentalOptionalList preserves an absent value versus an explicitly empty list.
- spaces::BoundExperimentalOne Box bound, exact in its domain: built implicitly from any arithmetic value (
boolis Bool, signed integers Int, unsigned Uint, floats Float). - spaces::BoxOptionsExperimental
Box's keyword arguments. - spaces::DiscreteOptionsExperimental
Discrete's keyword arguments. - spaces::SpaceSpecExperimentalImmutable data describing a space.
- spaces::SpaceExperimentalA space: a spec plus its sampler.
- spaces::BoxExperimentalA box of numbers in
[low, high]. - spaces::DiscreteExperimentalThe integers
start .. start + n. - spaces::DictExperimentalNamed child spaces, read in declaration order.
- spaces::MultiBinaryExperimental
- spaces::MultiDiscreteOptionsExperimental
- spaces::MultiDiscreteExperimental
- spaces::TextOptionsExperimental
- spaces::TextExperimental
- spaces::TupleExperimental
- specs::EnvContractExperimental
- adapters::TolerantExperimental
- adapters::ObsTransformExperimental
- adapters::RotationTransformExperimental
- adapters::RotationExperimental
- adapters::CustomEncodingExperimental
- adapters::ImageExperimental
- adapters::StateExperimental
- adapters::ConstantExperimental
- adapters::TextExperimental
- adapters::CustomExperimental
- adapters::ActuatorExperimental
- adapters::ImageTagExperimental
- adapters::StateTagExperimental
- adapters::TextTagExperimental
- adapters::FieldExperimental
- adapters::ConcatExperimental
- adapters::ActionExperimental
- adapters::SplitExperimental
- adapters::PreviousOptionsExperimental
- adapters::InputNodeExperimental
- adapters::ObsNodeExperimental
- adapters::ObservationRolesExperimental
- adapters::AdvisoryExperimental
- adapters::ModelSpecExperimental
- adapters::EnvTagsExperimental
- adapters::AdapterBaseExperimental
- adapters::AdapterExperimental
- adapters::ResolveOptionsExperimental
- EnvExperimentalValidation used a named lvalue; dispatch below deliberately tests a prvalue.
- VectorEnvExperimental
- ServedEnvExperimental
- ServeOptionsExperimental
- ext::EnvServerOptionsExperimental
- ext::ModelServeOptionsExperimental
- EnvServerOptionsExperimental
- EnvServerExperimental
- adapters::TagOptionsExperimental
- VariantExperimental
- EnvFactoryServeOptionsExperimental
- EnvFactoryBaseExperimental
- EnvFactoryExperimental
- types::EpisodeStateExperimental
- EpisodeEndHookExperimental
- ModelOptionsExperimental
- ModelServeOptionsExperimental
- ModelExperimental
- RemoteEnvOptionsExperimentalInvalid policy objects get a deleted-constructor diagnostic without participating as constructible handles or intercepting null pointer constants.
- RemoteModelOptionsExperimentalInvalid policy objects get a deleted-constructor diagnostic without participating as constructible handles or intercepting null pointer constants.
- RemoteEnvExperimentalInvalid policy objects get a deleted-constructor diagnostic without participating as constructible handles or intercepting null pointer constants.
- RemoteVectorEnvExperimental
- RemoteModelExperimental
- ModelTargetExperimental
- EnvTargetExperimental
- EpisodeResultExperimental
- TelemetryRowExperimental
- RunResultExperimental
- ReadItemExperimental
- ReaderExperimental
- SharedFunction<R (A...), EmptyError>Experimental
- FrameSourcesExperimental
- RunContextExperimental
- RunHooksExperimental
- ViewExperimental
- RunOptionsExperimental
- SessionOptionsExperimental
- SessionRunOptionsExperimental
- SessionExperimental
- MediaRefExperimental
- EpisodeRecordExperimental
- WorkloadRecordExperimental
- RecorderOptionsExperimental
- RecorderAddOptionsExperimental
- RecorderCaptureOptionsExperimental
- RecorderToDictOptionsExperimental
- RecorderExportOptionsExperimental
- RecorderExperimental
- DescribeOptionsExperimental
- DescribeJsonOptionsExperimental
Structs
- BuildInfoExperimentalThe linked library's identity.
- WarningExperimentalOne warning.
- NoAdapterExperimental
- TagParamExperimental
- types::LoadKeyExperimental
- types::PredictContextExperimental
- RandomSampleExperimental
- StepEventExperimental
Enums
- ErrorCodeExperimentalAn environment error's code (
EnvironmentException.code). - ModelErrorCodeExperimentalA model error's code (
ModelException.code). - BuildSourceExperimentalWhere a build's cohort came from.
- WarningCategoryExperimentalA warning's category (values of the C enum).
- DTypeExperimental
- DeviceExperimental
- ValueKindExperimental
- spaces::SpaceKindExperimentalA space's kind.
- spaces::BoundsKindExperimentalHow a Box stores its bounds.
- spaces::BoundTypeExperimentalThe C tag of a
Bound. - adapters::ImageLayoutExperimental
- adapters::FitModeExperimental
- adapters::FrameExperimental
- adapters::ProvenanceExperimental
- adapters::ReferenceExperimental
- adapters::ResampleExperimental
- adapters::RotationEncodingExperimental
- adapters::StackPadExperimental
- adapters::CropModeExperimental
- adapters::ChannelOrderExperimental
- adapters::StateContainerExperimental
- adapters::TextContainerExperimental
- adapters::StateSourceExperimental
- adapters::AdvisorySeverityExperimental
- TransportExperimental
- ViewBackendExperimental
- ViewFormatExperimental
- DescribeKindExperimental
Functions
- to_string()ExperimentalThe code's text ("INVALID_ACTION"); empty for an unknown value.
- build_info()ExperimentalThis library's build identity (
rlmesh.build_info()). - current_workflow_edition()ExperimentalThe bare
YYYY.MMworkflow edition this build runs at: the value to declare. - name()ExperimentalThe class name (
"WorkflowEditionWarning"). - is_subclass_of()ExperimentalTest class inheritance, including identity.
- set_warning_handler()ExperimentalInstall the process-wide warning handler; an empty
handlerrestores the default (stderr, each distinct warning once). - spaces::to_string()Experimental
- spaces::space_from_spec()ExperimentalBuild a space from a spec; refuses a spec with no payload.
- ext::box_elementwise()ExperimentalA Box with one bound pair per element (C++-only extra over
rlmesh_ext_box_elementwise_new). - trial_index()Experimental
- adapters::to_string()Experimental
- adapters::Previous()Experimental
- adapters::PARTS()Experimental
- adapters::ROTATION_DIMS()Experimental
- adapters::resolve()Experimental
- adapters::resolve_from_contract()Experimental
- adapters::tag()Experimental
- predict_seed()Experimental
- session()Experimental
- run()Experimental
- describe()Experimental
- describe_json()Experimental
- ext::env_server_describe_json()Experimental
- ext::register_entrypoint()Experimental
Type aliases
Show all 25Hide
- ext::DlpackPtrExperimental
using DlpackPtr = std::unique_ptr<DLManagedTensorVersioned, DlpackDeleter> - InfoDictExperimental
using InfoDict = Metadata - KwargsExperimental
using Kwargs = Metadata - spaces::BoxBoundExperimentalA Box's
low/high: one bound for every element, or one per element. - specs::SpaceSpecExperimental
using SpaceSpec = spaces::SpaceSpec - adapters::EncodingArmExperimental
using EncodingArm = std::variant<RotationTransform, std::string> - adapters::AxisValueExperimental
using AxisValue = std::variant<double, std::vector<double>> - adapters::ActionEncodingExperimental
using ActionEncoding = std::variant<RotationEncoding, CustomEncoding> - adapters::StackSpecExperimental
using StackSpec = std::vector<int32_t> - adapters::ConcatPartExperimental
using ConcatPart = std::variant<std::string, State, Constant> - adapters::ModelLeafExperimental
using ModelLeaf = std::variant<Image, State, Concat, Text, Custom> - adapters::ObsLeafExperimental
using ObsLeaf = std::variant<ImageTag, StateTag, TextTag, Split> - adapters::AdapterResolutionErrorExperimental
using AdapterResolutionError = rlmesh::AdapterResolutionError - adaptExperimental
namespace adapt = adapters - SpecArgExperimental
using SpecArg = std::variant<adapters::ModelSpec, NoAdapter> - DurationExperimental
using Duration = std::chrono::duration<double> - ResetResultExperimental
using ResetResult = std::tuple<Value, InfoDict> - StepResultExperimental
using StepResult = std::tuple<Value, double, bool, bool, InfoDict> - VectorStepResultExperimental
using VectorStepResult = std::tuple<Value, std::vector<double>, std::vector<bool>, std::vector<bool>, InfoDict> - VectorSeedExperimental
using VectorSeed = std::variant<int64_t, std::vector<int64_t>> - MadeEnvExperimental
using MadeEnv = std::variant<Env, VectorEnv> - types::SpecArgExperimental
using SpecArg = rlmesh::SpecArg - types::BatchPredictContextExperimental
using BatchPredictContext = Span<const PredictContext> - ReadFnExperimental
using ReadFn = SharedFunction<Value(const ReadItem&)> - RenderFnExperimental
using RenderFn = SharedFunction<Value()>
Constants
Show all 38Hide
- VERSIONExperimentalAllocation failure must not escape the C boundary either.
- DESCRIBE_METADATA_KEYExperimentalThe describe envelope's metadata key and schema version, and the env reset options key.
- DESCRIBE_SCHEMA_VERSIONExperimentalThe describe envelope's metadata key and schema version, and the env reset options key.
- ENV_RESET_OPTIONS_KEYExperimentalThe describe envelope's metadata key and schema version, and the env reset options key.
- adapters::IMAGE_PRIMARYExperimental
inline constexpr const char* IMAGE_PRIMARY = "image/primary" - adapters::IMAGE_SECONDARYExperimental
inline constexpr const char* IMAGE_SECONDARY = "image/secondary" - adapters::INSTRUCTIONExperimental
inline constexpr const char* INSTRUCTION = "text/instruction" - adapters::JOINT_POSExperimental
inline constexpr const char* JOINT_POS = "proprio/joint_pos" - adapters::JOINT_VELExperimental
inline constexpr const char* JOINT_VEL = "proprio/joint_vel" - adapters::ACTION_JOINT_POSExperimental
inline constexpr const char* ACTION_JOINT_POS = "action/joint_pos" - adapters::ACTION_JOINT_VELExperimental
inline constexpr const char* ACTION_JOINT_VEL = "action/joint_vel" - adapters::IMAGE_WRISTExperimental
inline constexpr const char* IMAGE_WRIST = "image/wrist" - adapters::EEF_POSExperimental
inline constexpr const char* EEF_POS = "proprio/eef_pos" - adapters::EEF_ROTExperimental
inline constexpr const char* EEF_ROT = "proprio/eef_rot" - adapters::GRIPPER_POSExperimental
inline constexpr const char* GRIPPER_POS = "proprio/gripper" - adapters::EEF_WRENCHExperimental
inline constexpr const char* EEF_WRENCH = "proprio/eef_wrench" - adapters::ACTION_DELTA_POSExperimental
inline constexpr const char* ACTION_DELTA_POS = "action/delta_eef_pos" - adapters::ACTION_DELTA_ROTExperimental
inline constexpr const char* ACTION_DELTA_ROT = "action/delta_eef_rot" - adapters::ACTION_GRIPPERExperimental
inline constexpr const char* ACTION_GRIPPER = "action/gripper" - adapters::ACTION_EEF_POSExperimental
inline constexpr const char* ACTION_EEF_POS = "action/eef_pos" - adapters::ACTION_EEF_ROTExperimental
inline constexpr const char* ACTION_EEF_ROT = "action/eef_rot" - adapters::BASE_ANG_VELExperimental
inline constexpr const char* BASE_ANG_VEL = "proprio/base_ang_vel" - adapters::BASE_ROTExperimental
inline constexpr const char* BASE_ROT = "proprio/base_rot" - adapters::COMMAND_BASE_VELExperimental
inline constexpr const char* COMMAND_BASE_VEL = "command/base_vel" - adapters::LEFT_ARMExperimental
inline constexpr const char* LEFT_ARM = "left_arm" - adapters::RIGHT_ARMExperimental
inline constexpr const char* RIGHT_ARM = "right_arm" - adapters::HEADExperimental
inline constexpr const char* HEAD = "head" - adapters::TORSOExperimental
inline constexpr const char* TORSO = "torso" - adapters::BASEExperimental
inline constexpr const char* BASE = "base" - adapters::LEFT_LEGExperimental
inline constexpr const char* LEFT_LEG = "left_leg" - adapters::RIGHT_LEGExperimental
inline constexpr const char* RIGHT_LEG = "right_leg" - adapters::ENV_METADATA_KEYExperimental
inline constexpr const char* ENV_METADATA_KEY = "rlmesh.adapters.v1.env_tags" - adapters::MODEL_METADATA_KEYExperimental
inline constexpr const char* MODEL_METADATA_KEY = "rlmesh.adapters.v1.model_spec" - adapters::ENV_BRANCH_METADATA_KEYExperimental
inline constexpr const char* ENV_BRANCH_METADATA_KEY = "rlmesh.adapters.v1.env_branch" - NO_ADAPTERExperimental
inline constexpr NoAdapter NO_ADAPTER{} - PolicyExperimental
template <class P> inline constexpr bool Policy = detail::has_predict<P> || detail::has_predict_batch<P> || detail::has_predict_chunk<P> || detail::has_predict_chunk_batch<P> - RANDOM_SAMPLEExperimental
inline constexpr RandomSample RANDOM_SAMPLE{} - recorder::SCHEMAExperimental
inline constexpr std::string_view SCHEMA = RLMESH_RECORDER_SCHEMA