Skip to content

Commit cc194be

Browse files
author
Jim Bennett
committed
Making things pass the builds
1 parent a19089b commit cc194be

File tree

5 files changed

+16
-13
lines changed

5 files changed

+16
-13
lines changed

README.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,6 @@ This is easily achieved by downloading
3232

3333
Installing from PyPI
3434
=====================
35-
.. note:: This library is not available on PyPI yet. Install documentation is included
36-
as a standard element. Stay tuned for PyPI availability!
37-
38-
.. todo:: Remove the above note if PyPI version is/will be available at time of release.
39-
If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
4035

4136
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
4237
PyPI <https://pypi.org/project/circuitpython_customvision/>`_. To install for current user:
@@ -63,7 +58,11 @@ To install in a virtual environment in your current project:
6358
Usage Example
6459
=============
6560

66-
.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
61+
.. code-block:: python
62+
63+
client = CustomVisionPredictionClient("api_key", "endpoint")
64+
65+
predictions = client.classify_image_url("project_id", "published_name", "https://www.adafruit.com/includes/templates/shop2019/images/adafruit-logo.png")
6766
6867
Contributing
6968
============

circuitpython_customvision/prediction/custom_vision_prediction_client.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
"""
22
Prediction client for the Azure Custom Vision service
3+
======================================================
4+
5+
Use this with models generated using https://customvision.ai
36
"""
47

58
import json

docs/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
55
.. use this format as the module name: "adafruit_foo.foo"
66
7-
.. automodule:: circuitpython-customvision
7+
.. automodule:: circuitpython_customvision.prediction.custom_vision_prediction_client
88
:members:

docs/index.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,9 @@ Table of Contents
2323
.. toctree::
2424
:caption: Tutorials
2525

26-
.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
27-
the toctree above for use later.
28-
2926
.. toctree::
3027
:caption: Related Products
3128

32-
.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
33-
the toctree above for use later.
34-
3529
.. toctree::
3630
:caption: Other Links
3731

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
from circuitpython_customvision.prediction.custom_vision_prediction_client import CustomVisionPredictionClient
2+
3+
client = CustomVisionPredictionClient("api_key", "endpoint")
4+
5+
predictions = client.classify_image_url(
6+
"project_id", "published_name", "https://www.adafruit.com/includes/templates/shop2019/images/adafruit-logo.png"
7+
)

0 commit comments

Comments
 (0)