fixes #28 - revised readme

mediumTaj · mediumTaj · commit 0b15f2a56876 · 2016-06-06T16:32:43.000-05:00
diff --git a/README.md b/README.md
@@ -295,7 +295,7 @@ private void OnGetClassifier(GetClassifiersPerClassifierVerbose classifier)
 }
 ```
 ##### Training classifiers
-Train a new classifier by uploading image data. Two compressed zip files containing at least two positive exampel files or one positive and one negative example file. The prefix of the positive example file is used as the classname for the new classifier ("<Class Name>_positive_examples"). Negative examples zip must be named "negative_examples". After a sucessful call, training the classifier takes a few minutes.
+Train a new classifier by uploading image data. Two compressed zip files containing at least two positive example files or one positive and one negative example file. The prefix of the positive example file is used as the classname for the new classifier ("<Class Name>_positive_examples"). Negative examples zip must be named "negative_examples". After a successful call, training the classifier takes a few minutes.
 
 ```cs
 private VisualRecognition m_VisualRecognition = new VisualRecognition();
@@ -382,7 +382,7 @@ private void OnClassify(ClassifyTopLevelMultiple classify)
         Log.Debug("ExampleVisualRecognition", "Classification failed!");
     }
 }
-``` 
+```
 
 ###### Classify an image by sending an image
 
@@ -433,7 +433,7 @@ private string m_imageURL = "https://upload.wikimedia.org/wikipedia/commons/e/e9
 void Start()
 {
 	if(!m_VisualRecognition.DetectFaces(m_imageURL, OnDetectFaces))
-        Log.Debug("ExampleVisualRecogntiion", "Detect faces failed!");
+        Log.Debug("ExampleVisualRecognition", "Detect faces failed!");
 }
 
 private void OnDetectFaces(FacesTopLevelMultiple multipleImages)
@@ -446,10 +446,10 @@ private void OnDetectFaces(FacesTopLevelMultiple multipleImages)
             Log.Debug("ExampleVisualRecognition", "\tsource_url: {0}, resolved_url: {1}", faces.source_url, faces.resolved_url);
             foreach(OneFaceResult face in faces.faces)
             {
-                Log.Debug("ExampleVisulaRecognition", "\t\tFace location: {0}, {1}, {2}, {3}", face.face_location.left, face.face_location.top, face.face_location.width, face.face_location.height);
-                Log.Debug("ExampleVisulaRecognition", "\t\tGender: {0}, Score: {1}", face.gender.gender, face.gender.score);
-                Log.Debug("ExampleVisulaRecognition", "\t\tAge Min: {0}, Age Max: {1}, Score: {2}", face.age.min, face.age.max, face.age.score);
-                Log.Debug("ExampleVisulaRecognition", "\t\tName: {0}, Score: {1}, Type Heiarchy: {2}", face.identity.name, face.identity.score, face.identity.type_hierarchy);
+                Log.Debug("ExampleVisualRecognition", "\t\tFace location: {0}, {1}, {2}, {3}", face.face_location.left, face.face_location.top, face.face_location.width, face.face_location.height);
+                Log.Debug("ExampleVisualRecognition", "\t\tGender: {0}, Score: {1}", face.gender.gender, face.gender.score);
+                Log.Debug("ExampleVisualRecognition", "\t\tAge Min: {0}, Age Max: {1}, Score: {2}", face.age.min, face.age.max, face.age.score);
+                Log.Debug("ExampleVisualRecognition", "\t\tName: {0}, Score: {1}, Type Hierarchy: {2}", face.identity.name, face.identity.score, face.identity.type_hierarchy);
             }
         }
     }
@@ -458,7 +458,7 @@ private void OnDetectFaces(FacesTopLevelMultiple multipleImages)
         Log.Debug("ExampleVisualRecognition", "Detect faces failed!");
     }
 }
-``` 
+```
 
 ###### Detect faces by sending an image
 
@@ -482,10 +482,10 @@ private void OnDetectFaces(FacesTopLevelMultiple multipleImages)
             Log.Debug("ExampleVisualRecognition", "\tsource_url: {0}, resolved_url: {1}", faces.source_url, faces.resolved_url);
             foreach(OneFaceResult face in faces.faces)
             {
-                Log.Debug("ExampleVisulaRecognition", "\t\tFace location: {0}, {1}, {2}, {3}", face.face_location.left, face.face_location.top, face.face_location.width, face.face_location.height);
-                Log.Debug("ExampleVisulaRecognition", "\t\tGender: {0}, Score: {1}", face.gender.gender, face.gender.score);
-                Log.Debug("ExampleVisulaRecognition", "\t\tAge Min: {0}, Age Max: {1}, Score: {2}", face.age.min, face.age.max, face.age.score);
-                Log.Debug("ExampleVisulaRecognition", "\t\tName: {0}, Score: {1}, Type Heiarchy: {2}", face.identity.name, face.identity.score, face.identity.type_hierarchy);
+                Log.Debug("ExampleVisualRecognition", "\t\tFace location: {0}, {1}, {2}, {3}", face.face_location.left, face.face_location.top, face.face_location.width, face.face_location.height);
+                Log.Debug("ExampleVisualRecognition", "\t\tGender: {0}, Score: {1}", face.gender.gender, face.gender.score);
+                Log.Debug("ExampleVisualRecognition", "\t\tAge Min: {0}, Age Max: {1}, Score: {2}", face.age.min, face.age.max, face.age.score);
+                Log.Debug("ExampleVisualRecognition", "\t\tName: {0}, Score: {1}, Type Hierarchy: {2}", face.identity.name, face.identity.score, face.identity.type_hierarchy);
             }
         }
     }
@@ -522,9 +522,9 @@ private void OnRecognizeText(TextRecogTopLevelMultiple multipleImages)
             Log.Debug("ExampleVisualRecognition", "\ttext: {0}", texts.text);
             foreach(TextRecogOneWord text in texts.words)
             {
-                Log.Debug("ExampleVisulaRecognition", "\t\ttext location: {0}, {1}, {2}, {3}", text.location.left, text.location.top, text.location.width, text.location.height);
-                Log.Debug("ExampleVisulaRecognition", "\t\tLine number: {0}", text.line_number);
-                Log.Debug("ExampleVisulaRecognition", "\t\tword: {0}, Score: {1}", text.word, text.score);
+                Log.Debug("ExampleVisualRecognition", "\t\ttext location: {0}, {1}, {2}, {3}", text.location.left, text.location.top, text.location.width, text.location.height);
+                Log.Debug("ExampleVisualRecognition", "\t\tLine number: {0}", text.line_number);
+                Log.Debug("ExampleVisualRecognition", "\t\tword: {0}, Score: {1}", text.word, text.score);
             }
         }
     }
@@ -533,7 +533,7 @@ private void OnRecognizeText(TextRecogTopLevelMultiple multipleImages)
         Log.Debug("ExampleVisualRecognition", "RecognizeText failed!");
     }
 }
-``` 
+```
 
 ###### Recognize text by sending an image
 
@@ -558,9 +558,9 @@ private void OnRecognizeText(TextRecogTopLevelMultiple multipleImages)
             Log.Debug("ExampleVisualRecognition", "\ttext: {0}", texts.text);
             foreach(TextRecogOneWord text in texts.words)
             {
-                Log.Debug("ExampleVisulaRecognition", "\t\ttext location: {0}, {1}, {2}, {3}", text.location.left, text.location.top, text.location.width, text.location.height);
-                Log.Debug("ExampleVisulaRecognition", "\t\tLine number: {0}", text.line_number);
-                Log.Debug("ExampleVisulaRecognition", "\t\tword: {0}, Score: {1}", text.word, text.score);
+                Log.Debug("ExampleVisualRecognition", "\t\ttext location: {0}, {1}, {2}, {3}", text.location.left, text.location.top, text.location.width, text.location.height);
+                Log.Debug("ExampleVisualRecognition", "\t\tLine number: {0}", text.line_number);
+                Log.Debug("ExampleVisualRecognition", "\t\tword: {0}, Score: {1}", text.word, text.score);
             }
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -295,7 +295,7 @@ private void OnGetClassifier(GetClassifiersPerClassifierVerbose classifier)`
`295`	`295`	`}`
`296`	`296`	```
`297`	`297`	`##### Training classifiers`
`298`		`-Train a new classifier by uploading image data. Two compressed zip files containing at least two positive exampel files or one positive and one negative example file. The prefix of the positive example file is used as the classname for the new classifier ("<Class Name>_positive_examples"). Negative examples zip must be named "negative_examples". After a sucessful call, training the classifier takes a few minutes.`
	`298`	`+Train a new classifier by uploading image data. Two compressed zip files containing at least two positive example files or one positive and one negative example file. The prefix of the positive example file is used as the classname for the new classifier ("<Class Name>_positive_examples"). Negative examples zip must be named "negative_examples". After a successful call, training the classifier takes a few minutes.`
`299`	`299`
`300`	`300`	```cs
`301`	`301`	`private VisualRecognition m_VisualRecognition = new VisualRecognition();`
`@@ -382,7 +382,7 @@ private void OnClassify(ClassifyTopLevelMultiple classify)`
`382`	`382`	`Log.Debug("ExampleVisualRecognition", "Classification failed!");`
`383`	`383`	`}`
`384`	`384`	`}`
`385`		-```
	`385`	+```
`386`	`386`
`387`	`387`	`###### Classify an image by sending an image`
`388`	`388`
`@@ -433,7 +433,7 @@ private string m_imageURL = "https://upload.wikimedia.org/wikipedia/commons/e/e9`
`433`	`433`	`void Start()`
`434`	`434`	`{`
`435`	`435`	`if(!m_VisualRecognition.DetectFaces(m_imageURL, OnDetectFaces))`
`436`		`- Log.Debug("ExampleVisualRecogntiion", "Detect faces failed!");`
	`436`	`+ Log.Debug("ExampleVisualRecognition", "Detect faces failed!");`
`437`	`437`	`}`
`438`	`438`
`439`	`439`	`private void OnDetectFaces(FacesTopLevelMultiple multipleImages)`
`@@ -446,10 +446,10 @@ private void OnDetectFaces(FacesTopLevelMultiple multipleImages)`
`446`	`446`	`Log.Debug("ExampleVisualRecognition", "\tsource_url: {0}, resolved_url: {1}", faces.source_url, faces.resolved_url);`
`447`	`447`	`foreach(OneFaceResult face in faces.faces)`
`448`	`448`	`{`
`449`		`- Log.Debug("ExampleVisulaRecognition", "\t\tFace location: {0}, {1}, {2}, {3}", face.face_location.left, face.face_location.top, face.face_location.width, face.face_location.height);`
`450`		`- Log.Debug("ExampleVisulaRecognition", "\t\tGender: {0}, Score: {1}", face.gender.gender, face.gender.score);`
`451`		`- Log.Debug("ExampleVisulaRecognition", "\t\tAge Min: {0}, Age Max: {1}, Score: {2}", face.age.min, face.age.max, face.age.score);`
`452`		`- Log.Debug("ExampleVisulaRecognition", "\t\tName: {0}, Score: {1}, Type Heiarchy: {2}", face.identity.name, face.identity.score, face.identity.type_hierarchy);`
	`449`	`+ Log.Debug("ExampleVisualRecognition", "\t\tFace location: {0}, {1}, {2}, {3}", face.face_location.left, face.face_location.top, face.face_location.width, face.face_location.height);`
	`450`	`+ Log.Debug("ExampleVisualRecognition", "\t\tGender: {0}, Score: {1}", face.gender.gender, face.gender.score);`
	`451`	`+ Log.Debug("ExampleVisualRecognition", "\t\tAge Min: {0}, Age Max: {1}, Score: {2}", face.age.min, face.age.max, face.age.score);`
	`452`	`+ Log.Debug("ExampleVisualRecognition", "\t\tName: {0}, Score: {1}, Type Hierarchy: {2}", face.identity.name, face.identity.score, face.identity.type_hierarchy);`
`453`	`453`	`}`
`454`	`454`	`}`
`455`	`455`	`}`
`@@ -458,7 +458,7 @@ private void OnDetectFaces(FacesTopLevelMultiple multipleImages)`
`458`	`458`	`Log.Debug("ExampleVisualRecognition", "Detect faces failed!");`
`459`	`459`	`}`
`460`	`460`	`}`
`461`		-```
	`461`	+```
`462`	`462`
`463`	`463`	`###### Detect faces by sending an image`
`464`	`464`
`@@ -482,10 +482,10 @@ private void OnDetectFaces(FacesTopLevelMultiple multipleImages)`
`482`	`482`	`Log.Debug("ExampleVisualRecognition", "\tsource_url: {0}, resolved_url: {1}", faces.source_url, faces.resolved_url);`
`483`	`483`	`foreach(OneFaceResult face in faces.faces)`
`484`	`484`	`{`
`485`		`- Log.Debug("ExampleVisulaRecognition", "\t\tFace location: {0}, {1}, {2}, {3}", face.face_location.left, face.face_location.top, face.face_location.width, face.face_location.height);`
`486`		`- Log.Debug("ExampleVisulaRecognition", "\t\tGender: {0}, Score: {1}", face.gender.gender, face.gender.score);`
`487`		`- Log.Debug("ExampleVisulaRecognition", "\t\tAge Min: {0}, Age Max: {1}, Score: {2}", face.age.min, face.age.max, face.age.score);`
`488`		`- Log.Debug("ExampleVisulaRecognition", "\t\tName: {0}, Score: {1}, Type Heiarchy: {2}", face.identity.name, face.identity.score, face.identity.type_hierarchy);`
	`485`	`+ Log.Debug("ExampleVisualRecognition", "\t\tFace location: {0}, {1}, {2}, {3}", face.face_location.left, face.face_location.top, face.face_location.width, face.face_location.height);`
	`486`	`+ Log.Debug("ExampleVisualRecognition", "\t\tGender: {0}, Score: {1}", face.gender.gender, face.gender.score);`
	`487`	`+ Log.Debug("ExampleVisualRecognition", "\t\tAge Min: {0}, Age Max: {1}, Score: {2}", face.age.min, face.age.max, face.age.score);`
	`488`	`+ Log.Debug("ExampleVisualRecognition", "\t\tName: {0}, Score: {1}, Type Hierarchy: {2}", face.identity.name, face.identity.score, face.identity.type_hierarchy);`
`489`	`489`	`}`
`490`	`490`	`}`
`491`	`491`	`}`
`@@ -522,9 +522,9 @@ private void OnRecognizeText(TextRecogTopLevelMultiple multipleImages)`
`522`	`522`	`Log.Debug("ExampleVisualRecognition", "\ttext: {0}", texts.text);`
`523`	`523`	`foreach(TextRecogOneWord text in texts.words)`
`524`	`524`	`{`
`525`		`- Log.Debug("ExampleVisulaRecognition", "\t\ttext location: {0}, {1}, {2}, {3}", text.location.left, text.location.top, text.location.width, text.location.height);`
`526`		`- Log.Debug("ExampleVisulaRecognition", "\t\tLine number: {0}", text.line_number);`
`527`		`- Log.Debug("ExampleVisulaRecognition", "\t\tword: {0}, Score: {1}", text.word, text.score);`
	`525`	`+ Log.Debug("ExampleVisualRecognition", "\t\ttext location: {0}, {1}, {2}, {3}", text.location.left, text.location.top, text.location.width, text.location.height);`
	`526`	`+ Log.Debug("ExampleVisualRecognition", "\t\tLine number: {0}", text.line_number);`
	`527`	`+ Log.Debug("ExampleVisualRecognition", "\t\tword: {0}, Score: {1}", text.word, text.score);`
`528`	`528`	`}`
`529`	`529`	`}`
`530`	`530`	`}`
`@@ -533,7 +533,7 @@ private void OnRecognizeText(TextRecogTopLevelMultiple multipleImages)`
`533`	`533`	`Log.Debug("ExampleVisualRecognition", "RecognizeText failed!");`
`534`	`534`	`}`
`535`	`535`	`}`
`536`		-```
	`536`	+```
`537`	`537`
`538`	`538`	`###### Recognize text by sending an image`
`539`	`539`
`@@ -558,9 +558,9 @@ private void OnRecognizeText(TextRecogTopLevelMultiple multipleImages)`
`558`	`558`	`Log.Debug("ExampleVisualRecognition", "\ttext: {0}", texts.text);`
`559`	`559`	`foreach(TextRecogOneWord text in texts.words)`
`560`	`560`	`{`
`561`		`- Log.Debug("ExampleVisulaRecognition", "\t\ttext location: {0}, {1}, {2}, {3}", text.location.left, text.location.top, text.location.width, text.location.height);`
`562`		`- Log.Debug("ExampleVisulaRecognition", "\t\tLine number: {0}", text.line_number);`
`563`		`- Log.Debug("ExampleVisulaRecognition", "\t\tword: {0}, Score: {1}", text.word, text.score);`
	`561`	`+ Log.Debug("ExampleVisualRecognition", "\t\ttext location: {0}, {1}, {2}, {3}", text.location.left, text.location.top, text.location.width, text.location.height);`
	`562`	`+ Log.Debug("ExampleVisualRecognition", "\t\tLine number: {0}", text.line_number);`
	`563`	`+ Log.Debug("ExampleVisualRecognition", "\t\tword: {0}, Score: {1}", text.word, text.score);`
`564`	`564`	`}`
`565`	`565`	`}`
`566`	`566`	`}`