allenai / ai2thor

An open-source platform for Visual AI.
http://ai2thor.allenai.org
Apache License 2.0
1.15k stars 216 forks source link

Documentation Error for GetSpawnCoordinatesAboveReceptacle's Parameter Behavior #1219

Open prathishpratt opened 4 months ago

prathishpratt commented 4 months ago

In the documentation for action="GetSpawnCoordinatesAboveReceptacle" the anywhere: bool = False parameter basically says the same for both True and False. It provides an unclear explanation of the behavior for a specific parameter that controls whether spawn coordinates are returned based on their visibility to the agent's field of view. The description given seems contradictory or at least ambiguous.

A clearer version could be: If set to True: "Spawn coordinates will be returned even if the exact position of the coordinate is outside of the agent’s field of view." If set to False: "Spawn coordinates will only be returned if they are within the agent’s field of view."