Skip to content

Commit

Permalink
update README in subfolders
Browse files Browse the repository at this point in the history
  • Loading branch information
dongyuanjushi committed Jun 29, 2024
1 parent d6305a6 commit 2af1269
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion aios/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# src/
# aios/

This folder contains the internal implementation of AIOS.

Expand Down
2 changes: 1 addition & 1 deletion aios/context/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# src/context
# aios/context

This folder contains the SimpleContextManager class and the base implementation.
This allows for snapshotting of context data for the LLMs.
Expand Down
2 changes: 1 addition & 1 deletion aios/llm_kernel/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# src/llm_kernel/
# aios/llm_kernel/

This directory contains wrapper classes that abstract the LLMs into a single class called LLMKernel. Currently, the following models are supported:

Expand Down
2 changes: 1 addition & 1 deletion aios/memory/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# src/memory/
# aios/memory/

Implements the memory management needed between the agents the LLMs so it can be shared across multiple agents.

Expand Down
2 changes: 1 addition & 1 deletion aios/storage/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# src/storage
# aios/storage
This directory contains a stub implementation that allows conversations to be offloaded to the disk. There is a stub implementation in `base.py`.

In the future, offloading to a database such as `sqlite` will be added in the `db_storage.py` file. Currently, only offloading to json is implemented in this directory.
2 changes: 1 addition & 1 deletion aios/utils/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# src/utils/
# aios/utils/

This directory consists of helper utilities that are used throughout the project.

Expand Down

0 comments on commit 2af1269

Please sign in to comment.