Skip to content

Commit

Permalink
Improve presentation (#1)
Browse files Browse the repository at this point in the history
- Remove or fix problematic links.
- Remove unclear text.

* Fix more links
  • Loading branch information
loverdos authored Sep 30, 2024
1 parent 3a4ad66 commit e5a4963
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 14 deletions.
13 changes: 1 addition & 12 deletions offchain/events/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
# Events

This directory contains the offchain event listener [sui_event.py][sui_event_py], which receives `RequestForCompletionEvent` events
This package contains the offchain event listener (`sui_event.py`), which receives `RequestForCompletionEvent` events
emitted by agents executing onchain. It then calls their required tools and passes those results with the defined prompt
to inference of specified models.

Any hosted Talus node would contain the contents of the `events` directory to efficiently handle requests
to their nodes models and tools.

**Towards hosted inference for Talus**
In the future, nodes can be modified to run inference using other's compute. [offchain.py][offchain_py] could be modified
to call any compute host for inference. Currently, [offchain.py][offchain_py] contains `process()` which calls the
[main.py][main_py] route `/predict`.

To see available models/tools and define new ones, see the [`tools` README.md][tools_readme].

## How to run this
Expand All @@ -26,7 +18,4 @@ When you start this service it expects the following variables that can be set e

<!-- References -->

[sui_event_py]: ./sui_event.py
[offchain_py]: ./offchain.py
[main_py]: ../tools/server/main.py
[tools_readme]: ../tools/README.md
4 changes: 2 additions & 2 deletions offchain/tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,5 @@ PYTHONPATH=src pytest tests
```

<!-- References -->
[main_py]: ./server/main.py
[tools_py]: ./server/tools/tools.py
[main_py]: ./src/nexus_tools/server/main.py
[tools_py]: ./src/nexus_tools/server/tools/tools.py

0 comments on commit e5a4963

Please sign in to comment.