Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] added touchups to readme.md #354

Closed
wants to merge 25 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
14a45aa
small touchups to readme, now that v.20 is merged
om-raheja Nov 30, 2024
305ef74
made change as per kai request
om-raheja Dec 1, 2024
3139eac
Merge branch 'agiresearch:main' into main
om-raheja Dec 12, 2024
eabb93a
Create python-app.yml
om-raheja Dec 13, 2024
01a4cac
Update python-app.yml
om-raheja Dec 13, 2024
a07d50e
update
dongyuanjushi Dec 13, 2024
728519f
Merge pull request #375 from dongyuanjushi/update-claude-readme
joshprk Dec 13, 2024
aba55da
refactor: clean up for installation (#376)
dongyuanjushi Dec 13, 2024
a6699e5
feat: add individual api key set up (#378)
BRama10 Dec 15, 2024
b55602f
Update python-app.yml
om-raheja Dec 17, 2024
4760d08
Update python-app.yml
om-raheja Dec 18, 2024
53610b5
Update python-app.yml
om-raheja Dec 18, 2024
9d9fef7
Update python-app.yml
om-raheja Dec 18, 2024
3084055
test: Adding workflows for automated testing for pull requests (#380)
evison Dec 19, 2024
3917c59
test: update the testing workflow to enable automated testing of PRs …
evison Dec 20, 2024
c92a704
update figures and readme
dongyuanjushi Dec 23, 2024
e87714e
Merge pull request #384 from dongyuanjushi/update-mode-fig
BRama10 Dec 24, 2024
7374f2b
fix: the display issue of different modes of AIOS (#386)
dongyuanjushi Dec 24, 2024
c6cbc66
fix: fixed bugs within address_syscall in ollama.py (#385)
davezflo Dec 25, 2024
00f84b1
fix: improve agent loading and error handling (#387)
XiangZhang-zx Dec 30, 2024
8de2295
fix: update gemini api key in workflow (#389)
evison Dec 31, 2024
7dd840c
feat: enable ollama models in github workflow for testing agents (#390)
dongyuanjushi Jan 3, 2025
b79efd7
feat: Add Configuration Management and Refresh Option for AIOS Kernel…
XiangZhang-zx Jan 4, 2025
e647740
Merge branch 'main' of github.com:om-raheja/AIOS
om-raheja Jan 6, 2025
9a276c3
added a second line if developers get confused on how to run kernel
om-raheja Jan 6, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,12 @@ Please see our ongoing [documentation](https://docs.aios.foundation/) for more i
Git clone AIOS kernel
```bash
git clone https://github.com/agiresearch/AIOS.git
cd AIOS && git checkout v0.2.0.beta
cd AIOS
```
Create venv environment (recommended)
```bash
python3.x -m venv venv # Only support for Python 3.10 and 3.11
python3.x --version # Check if it is 3.10 or 3.11
python3.x -m venv venv
source venv/bin/activate
```
or create conda environment
Expand All @@ -88,15 +89,15 @@ pip install -r requirements.txt
<!-- Note: Please use `launch.py` for the WebUI, or `agent_repl.py` for the TUI. -->
#### Configurations
##### Use with OpenAI API
You need to get your OpenAI API key from https://platform.openai.com/api-keys.
You need to get your OpenAI API key from https://platform.openai.com/api-keys. Note that API keys **cost money**.
Then set up your OpenAI API key as an environment variable

```bash
export OPENAI_API_KEY=<YOUR_OPENAI_API_KEY>
```

##### Use with Gemini API
You need to get your Gemini API key from https://ai.google.dev/gemini-api
You need to get your Gemini API key from https://ai.google.dev/gemini-api. Gemini is a free cloud LLM provider.

```bash
export GEMINI_API_KEY=<YOUR_GEMINI_API_KEY>
Expand Down