lebronJ / Cognitive-Face-Python

Python SDK for the Microsoft Face API, part of Cognitive Services

Microsoft Face API: Python SDK

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
• Read the documentation
• Find more SDKs & Samples

Installation

pip install cognitive_face

Installation from Source Code

python setup.py install

Unittests

Before running unittests, please refer to the /cognitive_face/tests/config.sample.py and set proper configuration with valid Subscription Key to make the unittests work.

python setup.py test

Minimal Usage

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

Sample

A Python SDK sample built with wxPython is also provided, before execution, please install all components listed below.

Sample Prerequisite

• Python 2.7 (only Python 2 supported due to limitation of wxPython)
• wxPython
• cognitive_face package

Sample Execution

git clone https://github.com/Microsoft/Cognitive-Face-Python.git
cd Cognitive-Face-Python
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 [e-mail] 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.