Updated ReadMe & Contributing (#1)
This commit is contained in:
Allison Light
GitHub
Родитель
4898d077d0
Коммит
faae0d2356
|
|
@ -0,0 +1,45 @@
|
|||
Contributing to Microsoft Cognitive Services Client Libraries & Samples
|
||||
===============================================
|
||||
So, you want to contribute on a client library or sample for one of the Microsoft Cognitive Services.
|
||||
Here's what you need to know.
|
||||
|
||||
1. Each SDK should include both a client library and a sample showing the API in
|
||||
action
|
||||
|
||||
2. When working on an SDK, it's important that we are consistent from project to project, so we ask you to follow the coding guidelines below:
|
||||
|
||||
- Windows [(Coding guidelines for C#)](https://msdn.microsoft.com/en-us/library/ff926074.aspx) -- also reference our [common Windows code](https://github.com/Microsoft/Cognitive-common-windows) for building samples
|
||||
|
||||
- Android [(Coding guidelines for
|
||||
Java)](<http://source.android.com/source/code-style.html>)
|
||||
|
||||
- iOS Objective-C [(Coding guidelines for
|
||||
Cocoa)](<https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html>)
|
||||
|
||||
- Optional: Client Javascript ([Coding guidelines for
|
||||
npm](<https://docs.npmjs.com/misc/coding-style>))
|
||||
|
||||
3. Samples are important for illustrating how to actually call into the API.
|
||||
Samples should be as visual and reusable as possible.
|
||||
|
||||
- Do:
|
||||
|
||||
- Create a UI sample when possible.
|
||||
|
||||
- Make your sample user friendly. Expect that developers will want to try
|
||||
different mainline scenarios and key APIs.
|
||||
|
||||
- Create code that's easy for other developers to copy/paste into their
|
||||
own solutions
|
||||
|
||||
- Consider:
|
||||
|
||||
- Adding UI to allow devs to quickly copy/paste subscription keys, instead
|
||||
of updating them in the code or using a config file. The
|
||||
FaceAPI-WPF-Samples.sln provides an example.
|
||||
|
||||
- Don't:
|
||||
|
||||
- Leave your subscription key in the source of samples. You do not want your key to be abused by others.
|
||||
|
||||
Happy coding!
|
||||
85
README.md
85
README.md
|
|
@ -1,37 +1,30 @@
|
|||
Microsoft Cognitive Services Face iOS SDK
|
||||
==================
|
||||
# Microsoft Face API: iOS Client Library & Sample
|
||||
This repo contains the iOS client library & sample for the Microsoft Face API, an offering within [Microsoft Cognitive Services](https://www.microsoft.com/cognitive-services), formerly known as Project Oxford.
|
||||
* [Learn about the Face API](https://www.microsoft.com/cognitive-services/en-us/face-api)
|
||||
* [Read the documentation](https://www.microsoft.com/cognitive-services/en-us/face-api/documentation/overview)
|
||||
* [Find more SDKs & Samples](https://www.microsoft.com/cognitive-services/en-us/SDK-Sample?api=face)
|
||||
|
||||
The iOS Face SDK allows you to use Microsoft Cognitive Services (formerly Microsoft Cognitive Services) Face REST APIs on the iOS platform.
|
||||
|
||||
Getting started
|
||||
==========
|
||||
## The Client Library
|
||||
The easiest way to consume the iOS client library is via CocoaPods. To install via Cocoapods
|
||||
1. [Install Cocoapods](http://guides.cocoapods.org/using/getting-started.html) - Follow the getting started guide to install Cocoapods.
|
||||
2. Add the following to your Podfile : `pod 'ProjectOxfordFace'`
|
||||
3. Run the command `pod install` to install the latest ProjectOxfordFace pod.
|
||||
4. Add `#import <ProjectOxfordFace/MPOFaceSDK.h>` to all files that need to reference the SDK.
|
||||
|
||||
The easiest way to consume the iOS client library is via CocoaPods.
|
||||
|
||||
### Install via Cocoapods
|
||||
* [Install Cocoapods](http://guides.cocoapods.org/using/getting-started.html) - Follow the getting started guide to install Cocoapods.
|
||||
* Add the following to your Podfile : `pod 'ProjectOxfordFace'`
|
||||
* Run the command `pod install` to install the latest ProjectOxfordFace pod.
|
||||
* Add `#import <ProjectOxfordFace/MPOFaceSDK.h>` to all files that need to reference the SDK.
|
||||
|
||||
Sample app
|
||||
==========
|
||||
The sample app demonstrate the use of Microsoft Cognitive Services (formerly Project Oxford) Face iOS SDK. The sample shows scenarios such as face detection, face verification, and face grouping.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
## The Sample
|
||||
The sample app demonstrates the use of the Microsoft Face API iOS client library. The sample shows scenarios such as face detection, face verification, and face grouping.
|
||||
|
||||
### Requirements
|
||||
iOS must be version 9.0 or higher.
|
||||
|
||||
Building and running the sample
|
||||
------------
|
||||
|
||||
### Building and running the sample
|
||||
The sample app should already have the necessary Pods shipped with it. Open the `ProjectOxfordFace.xcworkspace` in Xcode and build.
|
||||
|
||||
1. First, you must obtain a Face API subscription key by following instructions in [Microsoft Cognitive Services subscription](<https://www.microsoft.com/cognitive-services/en-us/sign-up>).
|
||||
2. Once in Xcode, under the example subdirectory, navigate to the file `MPODemoConstants.h` and insert your subscription key for the Face API
|
||||
3. To run the sample app, ensure that the target on top left side of Xcode is selected as `ProjectOxfordFace-Example` and select the play button or select Product > Run on the menu bar
|
||||
4. Once the app is launched, click on the buttons to try out the different scenarios.
|
||||
1. First, you must obtain a Face API subscription key by [following the instructions on our website](<https://www.microsoft.com/cognitive-services/en-us/sign-up>).
|
||||
2. Once in Xcode, under the example subdirectory, navigate to the file `MPODemoConstants.h` and insert your subscription key for the Face API
|
||||
3. To run the sample app, ensure that the target on top left side of Xcode is selected as `ProjectOxfordFace-Example` and select the play button or select Product > Run on the menu bar
|
||||
4. Once the app is launched, click on the buttons to try out the different scenarios.
|
||||
|
||||
Microsoft will receive the images you upload and may use them to improve Face API and related services. By submitting an image, you confirm you have consent from everyone in it.
|
||||
|
||||
|
|
@ -40,35 +33,37 @@ Microsoft will receive the images you upload and may use them to improve Face AP
|
|||
<img src="SampleScreenshots/SampleScreenshot3.png" width="30%"/>
|
||||
<img src="SampleScreenshots/SampleScreenshot4.png" width="30%"/>
|
||||
|
||||
Having issues?
|
||||
------------
|
||||
|
||||
1. Make sure you have selected `ProjectOxfordFace-Example` as the target.
|
||||
2. Make sure you have included the subscription key in `MPOTestConstants.h`.
|
||||
3. Make sure you have opened the `.xcworkspace` file and not the `.xcodeproj` file in Xcode.
|
||||
4. Make sure you have used the correct `Deployment Team` profile.
|
||||
5. Make sure you are running iOS 9.0 or higher
|
||||
### Having issues?
|
||||
1. Make sure you have selected `ProjectOxfordFace-Example` as the target.
|
||||
2. Make sure you have included the subscription key in `MPOTestConstants.h`.
|
||||
3. Make sure you have opened the `.xcworkspace` file and not the `.xcodeproj` file in Xcode.
|
||||
4. Make sure you have used the correct `Deployment Team` profile.
|
||||
5. Make sure you are running iOS 9.0 or higher
|
||||
|
||||
Running and exploring the unit tests
|
||||
--------------
|
||||
|
||||
Unit tests that demonstrate various Microsoft Cognitive Services (formerly Project Oxford) scenarios such as detection, identification, grouping, similarity, verification, and face lists are located at `Example/Tests`.
|
||||
### Running and exploring the unit tests
|
||||
Unit tests that demonstrate various Microsoft Cognitive Services scenarios such as detection, identification, grouping, similarity, verification, and face lists are located at `Example/Tests`.
|
||||
|
||||
To run the unit tests, first insert your subscription key in `MPOTestConstants.h` and then select the test navigator pane in Xcode to display all of the tests which can be run.
|
||||
|
||||
Contributing
|
||||
============
|
||||
We welcome contributions and are always looking for new SDKs, input, and
|
||||
suggestions. Feel free to file issues on the repo and we'll address them as we can. You can also learn more about how you can help on the [Contribution
|
||||
Rules & Guidelines](</CONTRIBUTING.md>).
|
||||
|
||||
For questions, feedback, or suggestions about Microsoft Cognitive Services, feel free to reach out to us directly.
|
||||
## 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](</CONTRIBUTING.md>).
|
||||
|
||||
- [Cognitive Services UserVoice Forum](<https://cognitive.uservoice.com>)
|
||||
You can reach out to us anytime with questions and suggestions using our communities below:
|
||||
- **Support questions:** [StackOverflow](<https://stackoverflow.com/questions/tagged/microsoft-cognitive>)
|
||||
- **Feedback & feature requests:** [Cognitive Services UserVoice Forum](<https://cognitive.uservoice.com>)
|
||||
|
||||
License
|
||||
=======
|
||||
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.
|
||||
|
||||
|
||||
## License
|
||||
All Microsoft Cognitive Services SDKs and samples are licensed with the MIT License. For more details, see
|
||||
[LICENSE](</LICENSE.md>).
|
||||
|
||||
Sample images are licensed separately, please refer to [LICENSE-IMAGE](</LICENSE-IMAGE.md>).
|
||||
|
||||
|
||||
## Developer Code of Conduct
|
||||
Developers using Cognitive Services, including this client library & sample, are expected to follow the “Developer Code of Conduct for Microsoft Cognitive Services”, found at [http://go.microsoft.com/fwlink/?LinkId=698895](http://go.microsoft.com/fwlink/?LinkId=698895).
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче