allenai / allenai/ai2thor

Documentation Error for GetSpawnCoordinatesAboveReceptacle's Parameter Behavior

Ouverte
#1,219 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
C#
Étoiles
1.8k
Forks
297
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

In the [documentation](https://ai2thor.allenai.org/ithor/documentation/interactive-physics/#sub-get-spawn-coordinate-above-receptacle) 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."

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.