allenai / allenai/ai2thor

Documentation Error for GetSpawnCoordinatesAboveReceptacle's Parameter Behavior

Aperta
#1,219 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
C#
Stelle
1.8k
Fork
297
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.