Skip to content

Commit

Permalink
test commit for image size
Browse files Browse the repository at this point in the history
test commit for image size

test commit for image size
  • Loading branch information
shashank40 committed Jul 1, 2024
1 parent 2cf9972 commit e46969a
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions getting-started/welcome-to-openadapt/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,18 +108,18 @@ Using python3.10 (3.10.13)

Notice the environment prefix `(openadapt-py3.10)`.

![image](./assets/poetry-shell.png)
<img src="./assets/poetry-shell.png" width="1500"">

# Run app locally for testing

`python -m openadapt.entrypoint`

CLI would look something like this after the command
![image](./assets/developer-run-local.png)
<img src="./assets/developer-run-local.png.png" width="1500"">

After it runs successfully, you will see an app tray at top right of screen

![image](./assets/app-tray.png)
<img src="./assets/app-tray.png" width="1500"">

# Make your first recording

Expand All @@ -133,7 +133,7 @@ To make your first recording, try the following command:
python -m openadapt.record "testing out openadapt"
```

![image](./assets/start-recording-commad.png)
<img src="./assets/start-recording-commad.png" width="1500">

Wait until all three event writers have started:

Expand All @@ -143,7 +143,7 @@ Wait until all three event writers have started:
| INFO | __mp_main__:write_events:230 - event_type='window' starting
```

![image](./assets/post-recording-start.png)
<img src="./assets/post-recording-start.png" width="1500">

To stop recording, focus the terminal and send **CTRL+C (SIGINT)**. The recording is finished saving when you see something like this:

Expand All @@ -158,7 +158,7 @@ To stop recording, focus the terminal and send **CTRL+C (SIGINT)**. The recordin
| INFO | __mp_main__:performance_stats_writer:433 - performance stats writer done
```

![image](./assets/recording-saved.png)
<img src="./assets/recording-saved.png" width="1500">

Current limitations:

Expand All @@ -173,15 +173,15 @@ Current limitations:

This will generate an HTML file and open a tab in your browser that looks something like this:

![image](./assets/visualize-1.png)
<img src="./assets/visualize-1.png" width="1500">

- For a more powerful dashboard, run:

`python -m openadapt.app.dashboard.run`

![image](./assets/visualize-2.png)
<img src="./assets/visualize-2.png" width="1500">

![image](./assets/visualize-2-1.png)
<img src="./assets/visualize-2-1.png" width="1500">

- For a desktop app-based visualization, run:

Expand All @@ -191,7 +191,7 @@ Read more on [openadapt.visualize](../../reference/api-reference/openadapt-modul

This will open a scrollable window that looks something like this:

![image](./assets/visualize-3.png)
<img src="./assets/visualize-3.png" width="1500">

# Playback

Expand Down Expand Up @@ -219,8 +219,8 @@ See [strategy list](https://github.com/OpenAdaptAI/OpenAdapt/tree/main/openadapt

`python3 -m openadapt.start`

![image](./assets/client.png)
<img src="./assets/client.png" width="660">

# Detailed performance monitoring via [pympler](https://pympler.readthedocs.io/en/latest/) and [tracemalloc](https://docs.python.org/3/library/tracemalloc.html):

![image](./assets/visualize-3.png)
<img src="./assets/visualize-3.png" width="1500">

0 comments on commit e46969a

Please sign in to comment.