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

test commit for image size

test commit for image size
  • Loading branch information
@shashank40
shashank40 committed Jul 1, 2024
1 parent 2cf9972 commit 36ecf25
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 29 deletions.
52 changes: 26 additions & 26 deletions getting-started/welcome-to-openadapt/developer-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
description: Working with OpenAdapt
---

# Developer Guide

{% hint style="info" %}
**Experiencing difficulty? Get support on our** [**Discord**](https://discord.gg/QKPuDqhDHF)**.**
{% endhint %}
Expand Down Expand Up @@ -64,13 +62,13 @@ alembic upgrade head
{% tab title="Scripted Installation" %}
[Download](https://openadapt.ai/#start)

# Windows:
## Windows:

- Press Windows Key, type "powershell", and press Enter
- Copy and paste the following command into the terminal, and press Enter (If Prompted for `User Account Control`, click 'Yes'):
- `Start-Process powershell -Verb RunAs -ArgumentList '-NoExit', '-ExecutionPolicy', 'Bypass', '-Command', "iwr -UseBasicParsing -Uri 'https://raw.githubusercontent.com/OpenAdaptAI/OpenAdapt/main/install/install_openadapt.ps1' | Invoke-Expression"`

# MacOS:
## MacOS:

- Download and install Git and Python 3.10
- Press Command+Space, type "terminal", and press Enter
Expand All @@ -80,7 +78,7 @@ alembic upgrade head
{% endtab %}
{% endtabs %}

# Permissions(IMPORTANT)
## Permissions(IMPORTANT)

See how to set up system permissions on macOS [here](https://github.com/OpenAdaptAI/OpenAdapt/blob/main/permissions_in_macOS.md).

Expand All @@ -89,9 +87,9 @@ See how to set up system permissions on macOS [here](https://github.com/OpenAdap
`pytest` to verify that the installation was successful.
{% endhint %}

## Usage
# Usage

# Shell
## Shell

Run this in every new terminal window once (while inside the `OpenAdapt` root directory) before running any `openadapt` commands below. This is required to activate the pythom environment:

Expand All @@ -108,20 +106,21 @@ Using python3.10 (3.10.13)

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

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

# Run app locally for testing
## 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 width="100%" src="./assets/developer-run-local.png.png" />

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

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

# Make your first recording
## Make your first recording

{% hint style="info" %}

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

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

Wait until all three event writers have started:

Expand All @@ -143,7 +142,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 width="100%" src="./assets/post-recording-start.png" />

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,30 +157,31 @@ 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 width="100%" src="./assets/recording-saved.png" />

Current limitations:

- Recording should be short (i.e. under a minute), as they are somewhat memory intensive, and there is currently an [open issue](https://github.com/OpenAdaptAI/OpenAdapt/issues/5) describing a possible memory leak.
- The only touchpad and trackpad gestures currently supported are pointing the cursor and left or right clicking, as described in this [open issue](https://github.com/OpenAdaptAI/OpenAdapt/issues/145)

# Visualize
## Visualize

- Quickly visualize the latest recording you created by running the following command:

`python -m openadapt.visualize`

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

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

- For a more powerful dashboard, run:

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

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


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

- For a desktop app-based visualization, run:

Expand All @@ -191,9 +191,9 @@ 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 width="100%" src="./assets/visualize-3.png" />

# Playback
## Playback

You can play back the recording using the following command:

Expand All @@ -213,14 +213,14 @@ e.g.: `python -m openadapt.replay VanillaReplayStrategy --instructions "calculat

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

## Features
# Features

# System Tray Icon and Client GUI App(work-in-progress)
## System Tray Icon and Client GUI App(work-in-progress)

`python3 -m openadapt.start`

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

# Detailed performance monitoring via [pympler](https://pympler.readthedocs.io/en/latest/) and [tracemalloc](https://docs.python.org/3/library/tracemalloc.html):
## 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 width="100%" src="./assets/visualize-3.png" />
29 changes: 26 additions & 3 deletions getting-started/welcome-to-openadapt/user-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
description: Installing OpenAdapt
---

# User Guide

{% hint style="info" %}
**Experiencing difficulty? Get support on our** [**Discord**](https://discord.gg/QKPuDqhDHF)**.**
{% endhint %}
Expand All @@ -20,11 +18,17 @@ We have builds available for Windows and Mac
{% endhint %}

- Download the OpenAdapt application from [here](https://openadapt.ai/#start)

![image](./assets/download-page.png)

- Extract the zip

![image](./assets/downloaded-zip.png)

- Click on the extracted application

- It creates an app-tray on top right. This app tray can be used to control the application.

![image](./assets/app-tray.png)


Expand All @@ -33,8 +37,11 @@ We have builds available for Windows and Mac
Now after the application is installed, you can start recording following the steps explained.

- Click the record button in the app-tray

- It opens up a prompt to name your recording

![image](./assets/record-prompt.png)

- Give it a name and click ok. Now the recording starts.


Expand All @@ -43,6 +50,7 @@ Now after the application is installed, you can start recording following the st
To end the recording you can simply

- Click the stop recording button in the app-tray and the recording is saved.

![image](./assets/stop-recording.png)


Expand All @@ -51,7 +59,9 @@ To end the recording you can simply
To replay the saved recordings

- Click on replay in the app-tray. It opens list of all the recordings.

![image](./assets/replay-list.png)

- Click on the recording you want to replay. This will open up a prompt to choose the **replay strategy** & **replay instructions**

![image](./assets/replay-strategy-prompt.png)
Expand All @@ -68,9 +78,13 @@ To replay the saved recordings
You can visualize data about your recording events too.

- Click on visualize in the app-tray

- Choose the recording you want to visualize

![image](./assets/visualize-list.png)

- It opens an HTML page with extensive details about the events in your recordings

![image](./assets/visualize-userapp-1.png)


Expand All @@ -79,7 +93,9 @@ You can visualize data about your recording events too.
If you want to delete any recording from OpenAdapt, you can do it easily.

- Click on delete button in app-tray

- A list of available recordings appear

- Choose the recording to delete


Expand All @@ -88,18 +104,25 @@ If you want to delete any recording from OpenAdapt, you can do it easily.
You can now control OpenAdapt from the GUI recently introduced. You can easily see all the **recordings**, **get recording data**, **change setting such as API keys**, choose to **scrubb a recording**, **replays** etc

- Click on dashboard in the app-tray

- A GUI opens on your browser similar to this

![image](./assets/dashboard.png)

- On settings page you can change API keys, turn on scrub etc

![image](./assets/dashboard-settings.png)


# Scrubbing
## Scrubbing

You can now scrub a recording of your choice and it gets processed.

- In the dashboard settings, turn on scrubbing.

- Navigate to scrubbing and choose a recording to scrub. Choose the provider

- Now wait for the recording to be processed

![image](./assets/scrubbing-processing.png)

0 comments on commit 36ecf25

Please sign in to comment.