curobo.rollout.cost.stop_cost module

class curobo.rollout.cost.stop_cost.StopCostConfig(weight: torch.Tensor | float | List[float], tensor_args: curobo.types.base.TensorDeviceType = None, distance_threshold: float = 0.0, classify: bool = False, terminal: bool = False, run_weight: float | None = None, dof: int = 7, vec_weight: torch.Tensor | List[float] | float | NoneType = None, max_value: float | None = None, hinge_value: float | None = None, vec_convergence: List[float] | None = None, threshold_value: float | None = None, return_loss: bool = False, max_limit: float | None = None, max_nlimit: float | None = None, dt_traj_params: curobo.rollout.dynamics_model.kinematic_model.TimeTrajConfig | None = None, horizon: int = 1)

Bases: CostConfig

Parameters:
  • weight (Tensor | float | List[float]) –

  • tensor_args (TensorDeviceType) –

  • distance_threshold (float) –

  • classify (bool) –

  • terminal (bool) –

  • run_weight (float | None) –

  • dof (int) –

  • vec_weight (Tensor | List[float] | float | None) –

  • max_value (float | None) –

  • hinge_value (float | None) –

  • vec_convergence (List[float] | None) –

  • threshold_value (float | None) –

  • return_loss (bool) –

  • max_limit (float | None) –

  • max_nlimit (float | None) –

  • dt_traj_params (TimeTrajConfig | None) –

  • horizon (int) –

max_limit: float | None = None
max_nlimit: float | None = None
dt_traj_params: TimeTrajConfig | None = None
horizon: int = 1
class curobo.rollout.cost.stop_cost.StopCost(config)

Bases: CostBase, StopCostConfig

Initialize class

Parameters:
  • config (Optional[CostConfig], optional) – To initialize this class directly, pass a config.

  • class (If this is a base) –

  • CostConfig. (it's assumed that you will initialize the child class with) –

  • None. (Defaults to) –

forward(vels)

Define the computation performed at every call.

Should be overridden by all subclasses.

Note

Although the recipe for forward pass needs to be defined within this function, one should call the Module instance afterwards instead of this since the former takes care of running the registered hooks while the latter silently ignores them.