You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 8, 2021. It is now read-only.
* Update the readme. Added a screenshot of the sample app.
* Fixed path to test config file
* Applied feedback received
* Applied feedback on readme
* Applied feedback on readme
Removed "questions" header
Copy file name to clipboardExpand all lines: README.md
+38-30Lines changed: 38 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,31 +1,19 @@
1
1
# Microsoft Face API: Python SDK
2
-
This repo contains the Python SDK for the Microsoft Face API, an offering within [Microsoft Cognitive Services](https://www.microsoft.com/cognitive-services), formerly known as Project Oxford.
2
+
This repo contains the Python SDK for the Microsoft Face API, an offering within [Microsoft Cognitive Services](https://azure.microsoft.com/en-us/services/cognitive-services/), formerly known as Project Oxford.
3
3
4
-
*[Learn about the Face API](https://www.microsoft.com/cognitive-services/en-us/face-api)
5
-
*[Read the documentation](https://www.microsoft.com/cognitive-services/en-us/face-api/documentation/overview)
6
-
*[Find more SDKs & Samples](https://www.microsoft.com/cognitive-services/en-us/SDK-Sample?api=face)
4
+
*[Learn about the Face API](https://azure.microsoft.com/en-us/services/cognitive-services/face/)
5
+
*[Read the documentation](https://docs.microsoft.com/en-us/azure/cognitive-services/face/overview)
Before running unittests, please refer to the [/cognitive_face/tests/config.sample.py](/cognitive_face/tests/config.sample.py) and set proper configuration with valid [Subscription Key](https://www.microsoft.com/cognitive-services/en-us/sign-up) to make the unittests work.
10
+
Install the module using [pip](https://pypi.python.org/pypi/pip/):
23
11
24
12
```bash
25
-
python setup.py test
13
+
pip install cognitive_face
26
14
```
27
15
28
-
## Minimal Usage
16
+
Use it:
29
17
30
18
```python
31
19
import cognitive_face asCF
@@ -41,27 +29,47 @@ result = CF.face.detect(img_url)
41
29
print result
42
30
```
43
31
44
-
##Sample
32
+
### Installing from the source code
45
33
46
-
A Python SDK sample built with wxPython is also provided, before execution,
47
-
please install all components listed below.
34
+
```bash
35
+
python setup.py install
36
+
```
48
37
49
-
### Sample Prerequisite
38
+
### Running the unit tests
50
39
51
-
-[Python 2.7](https://www.python.org/downloads/) (only Python 2 supported due
To run the tests you will need a valid subscription. You can get one [here](https://azure.microsoft.com/en-gb/try/cognitive-services/?api=face-api).
55
41
56
-
### Sample Execution
42
+
1. Copy `cognitive_face/tests/config.sample.py` into `cognitive_face/tests/config.py`.
43
+
1. Change the `KEY` and `BASE_URL` parameters to your own subscription's API key and endpoint.
44
+
1. Run the following:
45
+
46
+
```bash
47
+
python setup.py test
48
+
```
49
+
50
+
## Running the sample
51
+
52
+
A sample desktop application is also provided.
53
+
54
+
To run it, install the following prerequisites:
55
+
56
+
-[Python 2.7](https://www.python.org/downloads/) (version 3 is **not** currently supported, you can vote for this feature [here](https://github.com/Microsoft/Cognitive-Face-Python/issues/30))
57
+
-[wxPython 3.0.2](https://sourceforge.net/projects/wxpython/files/wxPython/3.0.2.0/) (version 4 is **not** currently supported)
We welcome contributions. Feel free to file issues and pull requests on the repo and we'll address them as we can. Learn more about how you can help on our [Contribution Rules & Guidelines](</CONTRIBUTING.md>).
66
74
67
75
You can reach out to us anytime with questions and suggestions using our communities below:
@@ -71,7 +79,7 @@ You can reach out to us anytime with questions and suggestions using our communi
71
79
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
72
80
73
81
## Updates
74
-
*[Face API Release Notes](https://www.microsoft.com/cognitive-services/en-us/face-api/documentation/ReleaseNotes)
82
+
*[Face API Release Notes](https://docs.microsoft.com/en-us/azure/cognitive-services/face/releasenotes)
75
83
76
84
## License
77
85
All Microsoft Cognitive Services SDKs and samples are licensed with the MIT License. For more details, see
0 commit comments