Add warning to AP set. (#781)

* Add warning to AP set. * Address comment
StanfordVL · May 6, 2022 · c21af90 · c21af90
1 parent bf9be46
commit c21af90
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/igibson/action_primitives/starter_semantic_action_primitives.py b/igibson/action_primitives/starter_semantic_action_primitives.py
@@ -1,3 +1,10 @@
+"""
+WARNING!
+The StarterSemanticActionPrimitive is a work-in-progress and is only provided as an example.
+It currently only works with BehaviorRobot with its JointControllers set to absolute mode.
+See provided behavior_robot_mp_behavior_task.yaml config file for an example. See examples/action_primitives for
+runnable examples.
+"""
 import inspect
 import logging
 import random
@@ -176,6 +183,12 @@ class StarterSemanticActionPrimitive(IntEnum):
 
 class StarterSemanticActionPrimitives(BaseActionPrimitiveSet):
     def __init__(self, task, scene, robot):
+        logger.warning(
+            "The StarterSemanticActionPrimitive is a work-in-progress and is only provided as an example. "
+            "It currently only works with BehaviorRobot with its JointControllers set to absolute mode. "
+            "See provided behavior_robot_mp_behavior_task.yaml config file for an example. "
+            "See examples/action_primitives for runnable examples."
+        )
         super().__init__(task, scene, robot)
         self.controller_functions = {
             StarterSemanticActionPrimitive.GRASP: self.grasp,