Skip to content

Potentially broken import paths in README examples (EchoEnv and KernRL) #379

Description

@insop

Description

After installing OpenEnv in editable mode:

cd OpenEnv  # a545400bdf0a0d0aaccd67d073fb74dbe4935ba3
pip install -e .

some of the import examples in the documentation result in errors.


1. EchoEnv Example

In the main README:
https://github.com/meta-pytorch/OpenEnv/blob/a545400bdf0a0d0aaccd67d073fb74dbe4935ba3/README.md#L34

The example shows:

>>> from echo_env import EchoAction, EchoEnv

This raises:

ImportError: cannot import name 'EchoAction' from 'echo_env' (/workspace/projs/proj3/OpenEnv/envs/echo_env/__init__.py)

The following import works instead:

>>> from echo_env import EchoEnv, CallToolAction, ListToolsAction

It appears that EchoAction is not exported (or has been renamed).


2. KernRL Example

In this file:
https://github.com/meta-pytorch/OpenEnv/blob/a545400bdf0a0d0aaccd67d073fb74dbe4935ba3/envs/kernrl/README.md#L30

The example shows:

>>> from openenv.envs.kernrl import kernrl_env, KernelAction

This raises:

ModuleNotFoundError: No module named 'openenv.envs'

The following import works instead:

>>> from kernrl import kernrl_env, KernelAction

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions