Skip to content

Commit

Permalink
Quick quicktour (#235)
Browse files Browse the repository at this point in the history
  • Loading branch information
lyie28 authored May 16, 2024
1 parent 52e5e5a commit 660ed5e
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 15 deletions.
18 changes: 7 additions & 11 deletions docs/docs/contributing/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ You can now install the lavague package from the root of your forked repo:

```bash
poetry shell
poetry install
poetry install --with dev
```

The poetry shell command will create a virtual environment specifically for this package.
Expand All @@ -76,24 +76,20 @@ This `install` command will install all the default packages in our LaVague pack

!!! note "Non-default package installation"

If you want to use a non-default integration, you will need to locally install this specific package.
If you want to use a non-default integration, you can then locally install the specific package with `pip`.

For example, if you want to use a non-default context such as the Gemini context. You would need to run:

```bash
cd lavague-integrations/contexts/lavague-contexts-gemini/
poetry install
pip install -e lavague-integrations/contexts/lavague-contexts-gemini
```

### Previewing local modifications

For local modifications to a package's files to be taken into account, you will need to locally install that specific package.
For local modifications to a package's files to be taken into account, you can locally install that specific package with `pip -e`.

For example, if you are making changes within the lavague.core package. You can run:
For example, if you are making changes within the lavague.core package. You can run the following command:

```bash
cd lavague-core
poetry install
```

You should only need to do this once.
pip install -e lavague-core
```
4 changes: 2 additions & 2 deletions docs/docs/get-started/quick-tour-notebook/quick-tour.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
"source": [
"## ActionEngine\n",
"\n",
"An agent is made up of two components: an `ActionEngine` and a `WorldModel`.\n",
"**An WebAgent is made up of two components: an `ActionEngine` and a `WorldModel`.**\n",
"\n",
"Let's start by initializing an `ActionEngine`, which is responsible for generating automation code for text instructions and executing them."
]
Expand Down Expand Up @@ -117,7 +117,7 @@
"source": [
"# World model\n",
"\n",
"Next, we will initialize our `WorldModel`, providing it with examples of global objectives for actions on this website being broken down into a chain of thoughts and then the next instruction to be passed to the `ActionEngine`."
"Next, we will initialize our `WorldModel`, providing it with a file containing examples of global objectives for actions to be taken on this website being broken down into a chain of thoughts, with the next instruction to be passed to the `ActionEngine`."
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/get-started/quick-tour.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ pip install lavague

## Action Engine

An agent is made up of two components: an `ActionEngine` and a `WorldModel`.
**An agent is made up of two components: an `ActionEngine` and a `WorldModel`.**

Let's start by initializing an `ActionEngine`, which is responsible for generating automation code for text instructions and executing them.

Expand All @@ -47,7 +47,7 @@ from lavague.core import WorldModel
world_model = WorldModel.from_hub("hf_example")
```

## Demo
## WebAgent Demo

We can now use these two elements to initialize a `WebAgent` and start playing with it!

Expand Down

0 comments on commit 660ed5e

Please sign in to comment.