allenai / ai2thor

An open-source platform for Visual AI.

Home Page:http://ai2thor.allenai.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Documentation Error for GetSpawnCoordinatesAboveReceptacle's Parameter Behavior

prathishpratt opened this issue · comments

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."