Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abrichr authored Nov 9, 2023
1 parent 97478b7 commit dbc2a16
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The direction is adjacent to [Adept.ai](https://adept.ai/), with some key differ
1. OpenAdapt is model agnostic
2. OpenAdapt generates prompts automatically (auto-prompted, not user-prompted)
3. OpenAdapt works with all types of desktop GUIs, including virtualized (e.g. Citrix) and web
4. OpenAdapt is open source! (license TBD, please see https://github.com/OpenAdaptAI/OpenAdapt/issues/246)
4. OpenAdapt is open source (MIT license)


## Install
Expand Down Expand Up @@ -141,7 +141,11 @@ You can play back the recording using the following command:
python -m openadapt.replay NaiveReplayStrategy
```

More ReplayStrategies coming soon! (see [Contributing](#Contributing)).
Other replay strategies include:

- [`StatefulReplayStrategy`](https://github.com/OpenAdaptAI/OpenAdapt/blob/main/openadapt/strategies/stateful.py): Proof-of-concept which uses the OpenAI GPT-4 API with prompts constructed via OS-level window data.

See https://github.com/OpenAdaptAI/OpenAdapt/tree/main/openadapt/strategies for a complete list. More ReplayStrategies coming soon! (see [Contributing](#Contributing)).


## Contributing
Expand All @@ -160,9 +164,10 @@ If it's not clear what `ActionEvent` is appropriate for the given `Screenshot`,
we can ask the user to take over temporarily to demonstrate the appropriate
course of action.

### Dataset
### Data Model

The data model consists of the following entities:

The dataset consists of the following entities:
1. `Recording`: Contains information about the screen dimensions, platform, and
other metadata.
2. `ActionEvent`: Represents a user action event such as a mouse click or key
Expand All @@ -174,12 +179,17 @@ The dataset consists of the following entities:
4. `WindowEvent`: Represents a window event such as a change in window title,
position, or size.

### API

You can assume that you have access to the following functions:

- `create_recording("doing taxes")`: Creates a recording.
- `get_latest_recording()`: Gets the latest recording.
- `get_events(recording)`: Returns a list of `ActionEvent` objects for the given
recording.

See https://openadapt.gitbook.io/openadapt.ai/ for more.

### Instructions

[Join us on Discord](https://discord.gg/yF527cQbDG). Then:
Expand Down

0 comments on commit dbc2a16

Please sign in to comment.