Skip to content
This repository was archived by the owner on Nov 8, 2021. It is now read-only.

Commit c9048b6

Browse files
miparnisarihuxuan
authored andcommitted
Updated readme (#42)
* 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
1 parent dd28822 commit c9048b6

File tree

2 files changed

+38
-30
lines changed

2 files changed

+38
-30
lines changed

Assets/sample_screenshot.png

168 KB
Loading

README.md

Lines changed: 38 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,19 @@
11
# 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.
33

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)
6+
* [More SDKs & Samples](https://azure.microsoft.com/en-us/resources/samples/?api=face&sort=0&service=cognitive-services&term=face)
77

8-
## Installation
8+
## Getting started
99

10-
```bash
11-
pip install cognitive_face
12-
```
13-
14-
## Installation from Source Code
15-
16-
```bash
17-
python setup.py install
18-
```
19-
20-
## Unittests
21-
22-
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/):
2311

2412
```bash
25-
python setup.py test
13+
pip install cognitive_face
2614
```
2715

28-
## Minimal Usage
16+
Use it:
2917

3018
```python
3119
import cognitive_face as CF
@@ -41,27 +29,47 @@ result = CF.face.detect(img_url)
4129
print result
4230
```
4331

44-
## Sample
32+
### Installing from the source code
4533

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+
```
4837

49-
### Sample Prerequisite
38+
### Running the unit tests
5039

51-
- [Python 2.7](https://www.python.org/downloads/) (only Python 2 supported due
52-
to limitation of wxPython)
53-
- [wxPython](https://wxpython.org/)
54-
- [cognitive_face package](https://pypi.python.org/pypi/cognitive_face)
40+
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).
5541

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)
58+
59+
Then run the following:
5760

5861
```bash
5962
git clone https://github.com/Microsoft/Cognitive-Face-Python.git
6063
cd Cognitive-Face-Python
64+
pip install -r requirements.txt
6165
python sample
6266
```
6367

68+
![Sample app](./Assets/sample_screenshot.png)
69+
70+
6471
## Contributing
72+
6573
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>).
6674

6775
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
7179
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.
7280

7381
## 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)
7583

7684
## License
7785
All Microsoft Cognitive Services SDKs and samples are licensed with the MIT License. For more details, see

0 commit comments

Comments
 (0)