Skip to content

Commit fed216e

Browse files
committed
fix: Make README.md render nicely on PyPI
1 parent 75ec6bb commit fed216e

4 files changed

Lines changed: 19 additions & 21 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
1. Clone the repository:
66
```bash
7-
git clone https://github.com/wildedge/wildedge-python.git
7+
git clone https://github.com/wild-edge/wildedge-python.git
88
cd wildedge-python
99
```
1010

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -59,21 +59,21 @@ client.instrument("transformers", hubs=["huggingface"])
5959

6060
| Integration | Example |
6161
|---|---|
62-
| `transformers` | [transformers_example.py](examples/transformers_example.py) |
63-
| `mlx` | [mlx_example.py](examples/mlx_example.py) |
64-
| `timm` | [timm_example.py](examples/timm_example.py) |
65-
| `gguf` | [gguf_example.py](examples/gguf_example.py) |
66-
| `onnx` | [onnx_example.py](examples/onnx_example.py) |
62+
| `transformers` | [transformers_example.py](https://github.com/wild-edge/wildedge-python/blob/main/examples/transformers_example.py) |
63+
| `mlx` | [mlx_example.py](https://github.com/wild-edge/wildedge-python/blob/main/examples/mlx_example.py) |
64+
| `timm` | [timm_example.py](https://github.com/wild-edge/wildedge-python/blob/main/examples/timm_example.py) |
65+
| `gguf` | [gguf_example.py](https://github.com/wild-edge/wildedge-python/blob/main/examples/gguf_example.py) |
66+
| `onnx` | [onnx_example.py](https://github.com/wild-edge/wildedge-python/blob/main/examples/onnx_example.py) |
6767
| `ultralytics` | - |
68-
| `tensorflow` | [tensorflow_example.py](examples/tensorflow_example.py) |
69-
| `torch` | [pytorch_example.py](examples/pytorch_example.py) |
70-
| `keras` | [keras_example.py](examples/keras_example.py) |
68+
| `tensorflow` | [tensorflow_example.py](https://github.com/wild-edge/wildedge-python/blob/main/examples/tensorflow_example.py) |
69+
| `torch` | [pytorch_example.py](https://github.com/wild-edge/wildedge-python/blob/main/examples/pytorch_example.py) |
70+
| `keras` | [keras_example.py](https://github.com/wild-edge/wildedge-python/blob/main/examples/keras_example.py) |
7171

7272
**Remote models**
7373

7474
| Integration | Example |
7575
|---|---|
76-
| `openai` | [openai_example.py](examples/openai_example.py) |
76+
| `openai` | [openai_example.py](https://github.com/wild-edge/wildedge-python/blob/main/examples/openai_example.py) |
7777

7878
**Hub tracking**
7979

@@ -84,7 +84,7 @@ Pass `hubs=` to track model download provenance. Hubs are framework-agnostic and
8484
| `huggingface` | Downloads via `huggingface_hub` |
8585
| `torchhub` | Downloads via `torch.hub` |
8686

87-
For unsupported frameworks, see [Manual tracking](docs/manual-tracking.md).
87+
For unsupported frameworks, see [Manual tracking](https://github.com/wild-edge/wildedge-python/blob/main/docs/manual-tracking.md).
8888

8989
## Configuration
9090

@@ -96,15 +96,14 @@ For unsupported frameworks, see [Manual tracking](docs/manual-tracking.md).
9696
| `enable_offline_persistence` | `true` | Persist unsent events to disk and replay on restart |
9797
| `sampling_interval_s` | `30.0` | Seconds between background hardware snapshots. Set to `0` or `None` to disable (or `WILDEDGE_SAMPLING_INTERVAL_S`) |
9898

99-
For advanced options (batching, queue tuning, dead-letter storage), see [Configuration](docs/configuration.md).
99+
For advanced options (batching, queue tuning, dead-letter storage), see [Configuration](https://github.com/wild-edge/wildedge-python/blob/main/docs/configuration.md).
100100

101101
## Privacy
102102

103103
Report security & priact issues to: wildedge@googlegroups.com.
104104

105105
## Links
106106

107-
- [Documentation](https://docs.wildedge.dev)
108-
- [Compatibility Matrix](docs/compatibility.md)
109-
- [Changelog](CHANGELOG.md)
110-
- [License](LICENSE)
107+
- [Compatibility Matrix](https://github.com/wild-edge/wildedge-python/blob/main/docs/compatibility.md)
108+
- [Changelog](https://github.com/wild-edge/wildedge-python/releases)
109+
- [License](https://github.com/wild-edge/wildedge-python/blob/main/LICENSE)

pyproject.toml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "wildedge-sdk"
3-
version = "0.1.0"
3+
version = "0.1.1"
44
description = "On-device ML inference monitoring for Python"
55
readme = "README.md"
66
requires-python = ">=3.10"
@@ -28,9 +28,8 @@ classifiers = [
2828

2929
[project.urls]
3030
Homepage = "https://wildedge.dev"
31-
Documentation = "https://docs.wildedge.dev"
32-
Source = "https://github.com/wildedge/wildedge-python"
33-
Changelog = "https://github.com/wildedge/wildedge-python/blob/main/CHANGELOG.md"
31+
Source = "https://github.com/wild-edge/wildedge-python"
32+
Changelog = "https://github.com/wild-edge/wildedge-python/releases"
3433

3534
[project.scripts]
3635
wildedge = "wildedge.cli:main"

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)