Microsoft Face API: Python SDK & Sample

This repo contains the Python SDK for the Microsoft Face API, an offering within Microsoft Cognitive Services, formerly known as Project Oxford.

• Learn about the Face API
• Documentation & API Reference & SDKs

Getting started

Install the module using pip:

pip install cognitive_face

Use it:

import cognitive_face as CF

KEY = 'subscription key'  # Replace with a valid Subscription Key here.
CF.Key.set(KEY)

BASE_URL = 'https://westus.api.cognitive.microsoft.com/face/v1.0/'  # Replace with your regional Base URL
CF.BaseUrl.set(BASE_URL)

img_url = 'https://raw.githubusercontent.com/Microsoft/Cognitive-Face-Windows/master/Data/detection1.jpg'
result = CF.face.detect(img_url)
print result

Installing from the source code

python setup.py install

Running the unit tests

To run the tests you will need a valid subscription. You can get one here.

1. Copy cognitive_face/tests/config.sample.py into cognitive_face/tests/config.py.
2. Change the KEY and BASE_URL parameters to your own subscription's API key and endpoint.
3. Run the following:

python setup.py test

Running the sample

A sample desktop application is also provided.

Currently it support the following combination of prerequisites:

1. Python 3 + wxPython 4 [Recommended]
2. Python 2 + wxPython 4
3. Python 2 + wxPython 3

P.S. WxPython 3 does not support Python 3 by design.

Then run the following:

git clone https://github.com/Microsoft/Cognitive-Face-Python.git
cd Cognitive-Face-Python
pip install -r requirements.txt
python sample

Contributing

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.

You can reach out to us anytime with questions and suggestions using our communities below:

• Support questions: StackOverflow
• Feedback & feature requests: Cognitive Services UserVoice Forum

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Updates

• Face API Release Notes

License

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

Sample images are licensed separately, please refer to LICENSE-IMAGE.

Developer Code of Conduct

Developers using Cognitive Services, including this sample, are expected to follow the “Developer Code of Conduct for Microsoft Cognitive Services”, found at http://go.microsoft.com/fwlink/?LinkId=698895.