Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
add instruction to launch ES server while using CodeNav as a library
  • Loading branch information
BigRedT authored Jul 24, 2024
1 parent 6b739cd commit 64fdb3b
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,10 @@ under the [codenav_examples](codenav_examples) directory:
- [create_code_env.py](codenav_examples%2Fcreate_code_env.py)): Creates a `PythonCodeEnv` object and then executes a given code string in this environemnt
- [create_prompt.py](codenav_examples%2Fcreate_prompt.py): Creates a custom prompt and instantiates and CodeNav agent with that prompt.

**Note** - You will still need to launch ElasticSearch server before running any of the above. To do so run
```
python -m codenav.codenav_run init
```

## Elasticsearch & Indexing Gotchas 🤔

Expand Down Expand Up @@ -134,4 +138,4 @@ This project is licensed under the Apache 2.0 License.
primaryClass={cs.AI},
url={https://arxiv.org/abs/2406.12276},
}
```
```

0 comments on commit 64fdb3b

Please sign in to comment.