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

Update README.md - remove pip reference for now #84

Merged
merged 1 commit into from
Mar 7, 2025
Merged
Changes from all commits
Commits
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
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ Depending on the front ends, datago can be rank and world-size aware, in which c

<details> <summary><strong>Use it</strong></summary>

Using Python 3.11, you can simply install datago with `pip install datago`
~Using Python 3.11, you can simply install datago with `pip install datago`~
See https://github.com/Photoroom/datago/issues/83, needs fixing

## Use the package from Python

Expand All @@ -48,6 +49,30 @@ for _ in range(10):
```

Please note that the image buffers will be passed around as raw pointers, see below.
To test datago while serving local files (jpg, png, ..), code would look like the following

```python
from datago import DatagoClient
import os
import json

config = {
"source_type": "file",
"source_config": {
"root_path": "myPath",
},
"limit": 200,
"rank": 0,
"world_size": 1,
"samples_buffer_size": 32,
}

client = DatagoClient(json.dumps(config))

for _ in range(10):
sample = client.get_sample()
```


## Match the raw exported buffers with typical python types

Expand Down
Loading