Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pbarker committed Sep 5, 2024
1 parent 7602237 commit db0246f
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 10 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,27 @@ pip install surfkit
- MacOS or Linux
- [Qemu](https://www.qemu.org/download/#macos)

### Create an Agent
### Python

Use an agent to solve a task

```python
from surfkit import solve

task = solve(
"Search for the most common variety of french duck",
agent_type="mariyadavydova/SurfSlicer",
device_type="desktop",
)

task.wait_for_done()

result = task.result
```

### CLI

#### Create an Agent

Find available agents on the Hub

Expand All @@ -69,7 +89,7 @@ List running agents
surfkit list agents
```

### Create a Device
#### Create a Device

Create an Ubuntu desktop for our agent to use.

Expand All @@ -83,7 +103,7 @@ List running devices
surfkit list devices
```

### Solve a task
#### Solve a task

Use the agent to solve a task on the device

Expand Down
8 changes: 4 additions & 4 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "surfkit"
version = "0.1.238"
version = "0.1.239"
description = "A toolkit for building AI agents that use devices"
authors = ["Patrick Barker <[email protected]>"]
license = "MIT"
Expand All @@ -22,7 +22,7 @@ rich = "^13.7.1"
tqdm = "^4.66.4"
agentdesk = "^0.2.93"
kubernetes = "^30.1.0"
taskara = "^0.1.125"
taskara = "^0.1.126"


[tool.poetry.group.dev.dependencies]
Expand Down
1 change: 1 addition & 0 deletions surfkit/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
)

from surfkit.client import solve
from taskara import Task, TaskStatus
11 changes: 10 additions & 1 deletion surfkit/client.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import logging
from typing import Optional
from typing import Optional, Dict

from agentdesk import Desktop
from namesgenerator import get_random_name
Expand Down Expand Up @@ -418,3 +418,12 @@ def solve(
except:
pass
return task


def learn(
description: str,
parameters: Dict[str, str] = {},
device_type: str = "desktop",
starting_url: Optional[str] = None,
):
pass
12 changes: 12 additions & 0 deletions surfkit/learn/base.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
from abc import ABC, abstractmethod


class Teacher(ABC):

@abstractmethod
def teach(self, *args, **kwargs):
pass


class LLMTeach(Teacher):
pass

0 comments on commit db0246f

Please sign in to comment.