Skip to content

Commit a28c7f1

Browse files
author
Jim Bennett
committed
Adding more examples
1 parent bab0764 commit a28c7f1

10 files changed

+460
-93
lines changed

.github/workflows/build.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ jobs:
4545
run: git describe --dirty --always --tags
4646
- name: PyLint
4747
run: |
48-
pylint $( find . -path './customvision.py' )
49-
([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" ))
48+
pylint $( find . -path './azurecustomvision_prediction.py' )
49+
([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace,wrong-import-position $( find . -path "./examples/*.py" ))
5050
- name: Check formatting
5151
run: |
5252
black --check --target-version=py35 --line-length 140 .

README.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
Introduction
22
============
33

4-
.. image:: https://readthedocs.org/projects/circuitpython_customvision/badge/?version=latest
5-
:target: https://circuitpython.readthedocs.io/projects/circuitpython_customvision/en/latest/
4+
.. image:: https://readthedocs.org/projects/circuitpython_azurecustomvision_prediction/badge/?version=latest
5+
:target: https://circuitpython.readthedocs.io/projects/circuitpython_azurecustomvision_prediction/en/latest/
66
:alt: Documentation Status
77

88
.. image:: https://img.shields.io/discord/327254708534116352.svg
99
:target: https://discord.gg/nBQh6qu
1010
:alt: Discord
1111

12-
.. image:: https://github.com/JimBobBennett/CircuitPython_CustomVision/workflows/Build%20CI/badge.svg
13-
:target: https://github.com/JimBobBennett/CircuitPython_CustomVision/actions
12+
.. image:: https://github.com/JimBobBennett/CircuitPython_AzureCustomVision_Prediction/workflows/Build%20CI/badge.svg
13+
:target: https://github.com/JimBobBennett/CircuitPython_AzureCustomVision_Prediction/actions
1414
:alt: Build Status
1515

1616
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
@@ -19,19 +19,20 @@ Introduction
1919

2020
CircuitPython prediction library for the Azure custom vision service.
2121

22-
To use this library, you will need to create a custom vision project at [CustomVision.ai](https://customvision.ai?WT.mc_id=circuitpythoncustomvisionprediction-github-jabenn).
22+
To use this library, you will need to create a custom vision project at [CustomVision.ai](https://customvision.ai?WT.mc_id=circuitpythonazurecustomvisionprediction-github-jabenn).
2323
Once you have your project, you will need to train either an image classification model, or an object detection model. You can then use this library to make predictions against this model.
2424

2525
You can read more on how to do this in the Microsoft docs:
2626

27-
* [Train an image classifier](https://docs.microsoft.com/azure/cognitive-services/custom-vision-service/getting-started-build-a-classifier?WT.mc_id=circuitpythoncustomvisionprediction-github-jabenn)
28-
* [Train an object detection model](https://docs.microsoft.com/azure/cognitive-services/custom-vision-service/get-started-build-detector?WT.mc_id=circuitpythoncustomvisionprediction-github-jabenn)
27+
- `Train an image classifier <https://aka.ms/AA88qph>`_
28+
- `Train an object detection model <https://aka.ms/AA88llc>`_
2929

3030
Dependencies
3131
=============
3232
This driver depends on:
3333

3434
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
35+
* `Adafruit CircuitPython Requests <https://github.com/adafruit/Adafruit_CircuitPython_Requests>`_
3536

3637
Please ensure all dependencies are available on the CircuitPython filesystem.
3738
This is easily achieved by downloading
@@ -41,17 +42,17 @@ Installing from PyPI
4142
=====================
4243

4344
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
44-
PyPI <https://pypi.org/project/circuitpython_customvision/>`_. To install for current user:
45+
PyPI <https://pypi.org/project/circuitpython_azurecustomvision_prediction/>`_. To install for current user:
4546

4647
.. code-block:: shell
4748
48-
pip3 install circuitpython-customvision
49+
pip3 install circuitpython-azurecustomvision-prediction
4950
5051
To install system-wide (this may be required in some cases):
5152

5253
.. code-block:: shell
5354
54-
sudo pip3 install circuitpython-customvision
55+
sudo pip3 install circuitpython-azurecustomvision-prediction
5556
5657
To install in a virtual environment in your current project:
5758

@@ -60,7 +61,7 @@ To install in a virtual environment in your current project:
6061
mkdir project-name && cd project-name
6162
python3 -m venv .env
6263
source .env/bin/activate
63-
pip3 install circuitpython-customvision
64+
pip3 install circuitpython-azurecustomvision-prediction
6465
6566
Usage Example
6667
=============
@@ -75,7 +76,7 @@ Contributing
7576
============
7677

7778
Contributions are welcome! Please read our `Code of Conduct
78-
<https://github.com/JimBobBennett/CircuitPython_CustomVision/blob/master/CODE_OF_CONDUCT.md>`_
79+
<https://github.com/JimBobBennett/CircuitPython_azurecustomvision_Prediction/blob/master/CODE_OF_CONDUCT.md>`_
7980
before contributing to help this project stay welcoming.
8081

8182
Documentation

0 commit comments

Comments
 (0)