Skip to content

Clarify ObsType and the observation number#207

Merged
tyler-griggs merged 1 commit intoNovaSky-AI:mainfrom
DataDog:etnbrd/fix-obstype
Aug 26, 2025
Merged

Clarify ObsType and the observation number#207
tyler-griggs merged 1 commit intoNovaSky-AI:mainfrom
DataDog:etnbrd/fix-obstype

Conversation

@etnbrd
Copy link
Contributor

@etnbrd etnbrd commented Aug 26, 2025

This PR clarify the difference between observation and observations, and that ObsType holds the latter in the Env class.

resolves #198

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request effectively clarifies the distinction between observation and observations by updating docstrings and type hints. The change from str to ConversationType for ObsType in BaseTextEnv makes the expected data structure much clearer. I have one minor suggestion to further improve the clarity in a docstring to align with the goals of this PR. For full consistency, you might want to perform a global search for observation in docstrings to catch any remaining instances.

@tyler-griggs tyler-griggs self-assigned this Aug 26, 2025
@tyler-griggs tyler-griggs merged commit 4623b37 into NovaSky-AI:main Aug 26, 2025
3 checks passed
tyler-griggs added a commit that referenced this pull request Aug 27, 2025
#207 just corrected an error in `BaseTextEnv`. This PR propagates it to
the docs
dzorlu referenced this pull request in fleet-ai/SkyRL Feb 4, 2026
This PR clarify the difference between `observation` and `observations`,
and that `ObsType` holds the latter in the `Env` class.

resolves #198
dzorlu referenced this pull request in fleet-ai/SkyRL Feb 4, 2026
#207 just corrected an error in `BaseTextEnv`. This PR propagates it to
the docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify what is ObsType: is it the type for a single observation, or a list of observations?

2 participants