Skip to content

Commit b31ff37

Browse files
authored
Small markdown improvements (#44)
* Add readme to doc tests * formatting * Add sample images * Delete images
1 parent 47c5611 commit b31ff37

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ test-integ: install ## Run tests against the integ API server (needs GROUNDLIGH
3737
GROUNDLIGHT_ENDPOINT="https://api.integ.groundlight.ai/" ${PYTEST} ${TEST_ARGS} test
3838

3939
test-docs: install ## Run the example code and tests in our docs against the prod API (needs GROUNDLIGHT_API_TOKEN)
40-
poetry run pytest -v --markdown-docs ${TEST_ARGS} docs
40+
poetry run pytest -v --markdown-docs ${TEST_ARGS} docs README.md
4141

4242
# Adjust which paths we lint
4343
LINT_PATHS="src test bin samples"

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,18 @@ Groundlight makes it simple to build reliable visual applications. Read the [ful
88
pip install groundlight
99
```
1010

11-
Build a working computer vision system in just 5 lines of python:
11+
Build a working computer vision system in just a few lines of python:
1212

1313
```python
1414
from groundlight import Groundlight
15+
from PIL import Image
16+
import requests
1517

1618
gl = Groundlight()
17-
d = gl.get_or_create_detector(name="door", query="Is the door open?")
18-
image_query = gl.submit_image_query(detector=d, image=jpeg_img)
19+
d = gl.get_or_create_detector(name="doorway", query="Is the doorway open?")
20+
image_url = "https://images.selfstorage.com/large-compress/2174925f24362c479b2.jpg"
21+
image = Image.open(requests.get(image_url, stream=True).raw)
22+
image_query = gl.submit_image_query(detector=d, image=image)
1923
print(f"The answer is {image_query.result}")
2024
```
2125

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
[tool.poetry]
22
authors = ["Groundlight AI <[email protected]>"]
33
description = "Build computer vision systems from natural language with Groundlight"
4-
homepage = "https://www.groundlight.ai"
4+
homepage = "https://code.groundlight.ai/python-sdk"
55
license = "MIT"
66
name = "groundlight"
77
packages = [
88
{include = "**/*.py", from = "generated"},
99
{include = "**/*.py", from = "src"},
1010
]
1111
readme = "README.md"
12-
version = "0.7.6"
12+
version = "0.7.7"
1313

1414
[tool.poetry.dependencies]
1515
certifi = "^2021.10.8"

0 commit comments

Comments
 (0)