allenai / allenai/ai2thor

Documentation Error for GetSpawnCoordinatesAboveReceptacle's Parameter Behavior

オープン
#1,219 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
C#
スター
1.8k
フォーク
296
PR マージ指標
30日以内にマージされた PR はありません

説明

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

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。