Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 44 additions & 44 deletions lib/services/customVision/training/README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,44 @@
---
uid: azure-cognitiveservices-customvision-training
summary: *content

---
**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.**
## Microsoft Azure SDK for Node.js - TrainingAPIClient

This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher**

### Features


### How to Install

```bash
npm install azure-cognitiveservices-customvision-training
```

### How to use

#### Authentication, client creation, and getDomains as an example.

```javascript
const msRest = require("ms-rest");
const TrainingAPIClient = require("azure-cognitiveservices-customvision-training");
const token = "<access_token>";
const creds = new msRest.TokenCredentials(token);
const subscriptionId = "<Subscription_Id>";
const client = new TrainingAPIClient(creds, subscriptionId);

client.getDomains().then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log('An error occurred:');
console.dir(err, {depth: null, colors: true});
});
```

### Related projects

- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node)
---
uid: azure-cognitiveservices-customvision-training
summary: *content
---
**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.**
## Microsoft Azure SDK for Node.js - TrainingAPIClient
This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher**
### Features
### How to Install
```bash
npm install azure-cognitiveservices-customvision-training
```
### How to use
#### Authentication, client creation, and getDomains as an example.
```javascript
const msRest = require("ms-rest");
const TrainingAPIClient = require("azure-cognitiveservices-customvision-training");
const token = "<access_token>";
const creds = new msRest.TokenCredentials(token);
const subscriptionId = "<Subscription_Id>";
const client = new TrainingAPIClient(creds, subscriptionId);
client.getDomains().then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log('An error occurred:');
console.dir(err, {depth: null, colors: true});
});
```
### Related projects
- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node)
2 changes: 1 addition & 1 deletion lib/services/customVision/training/lib/models/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ export interface Project {
*/
readonly created?: Date;
/**
* Gets the date this project was last modifed.
* Gets the date this project was last modified.
*/
readonly lastModified?: Date;
/**
Expand Down
2 changes: 1 addition & 1 deletion lib/services/customVision/training/lib/models/project.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class Project {
* 'Multilabel'
* @property {date} [created] Gets the date this project was created.
* @property {date} [lastModified] Gets the date this project was last
* modifed.
* modified.
* @property {string} [thumbnailUri] Gets the thumbnail url representing the
* project.
*/
Expand Down
16 changes: 8 additions & 8 deletions lib/services/customVision/training/lib/trainingAPIClient.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {array} imageIds Image ids. Limited to 64 images.
*
* @param {array} tagIds Tags to be deleted from the specified images. Limted
* @param {array} tagIds Tags to be deleted from the specified images. Limited
* to 20 tags.
*
* @param {object} [options] Optional Parameters.
Expand All @@ -374,7 +374,7 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {array} imageIds Image ids. Limited to 64 images.
*
* @param {array} tagIds Tags to be deleted from the specified images. Limted
* @param {array} tagIds Tags to be deleted from the specified images. Limited
* to 20 tags.
*
* @param {object} [options] Optional Parameters.
Expand Down Expand Up @@ -874,7 +874,7 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {array} imageIds Ids of the images to be deleted. Limted to 256
* @param {array} imageIds Ids of the images to be deleted. Limited to 256
* images per batch.
*
* @param {object} [options] Optional Parameters.
Expand All @@ -895,7 +895,7 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {array} imageIds Ids of the images to be deleted. Limted to 256
* @param {array} imageIds Ids of the images to be deleted. Limited to 256
* images per batch.
*
* @param {object} [options] Optional Parameters.
Expand Down Expand Up @@ -1087,8 +1087,8 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {object} batch Image and tag ids. Limted to 64 images and 20 tags per
* batch.
* @param {object} batch Image and tag ids. Limited to 64 images and 20 tags
* per batch.
*
* @param {array} [batch.images]
*
Expand All @@ -1115,8 +1115,8 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {object} batch Image and tag ids. Limted to 64 images and 20 tags per
* batch.
* @param {object} batch Image and tag ids. Limited to 64 images and 20 tags
* per batch.
*
* @param {array} [batch.images]
*
Expand Down
24 changes: 12 additions & 12 deletions lib/services/customVision/training/lib/trainingAPIClient.js
Original file line number Diff line number Diff line change
Expand Up @@ -739,7 +739,7 @@ function _createImageTags(projectId, batch, options, callback) {
*
* @param {array} imageIds Image ids. Limited to 64 images.
*
* @param {array} tagIds Tags to be deleted from the specified images. Limted
* @param {array} tagIds Tags to be deleted from the specified images. Limited
* to 20 tags.
*
* @param {object} [options] Optional Parameters.
Expand Down Expand Up @@ -1860,7 +1860,7 @@ function _createImagesFromData(projectId, imageData, options, callback) {
*
* @param {uuid} projectId The project id.
*
* @param {array} imageIds Ids of the images to be deleted. Limted to 256
* @param {array} imageIds Ids of the images to be deleted. Limited to 256
* images per batch.
*
* @param {object} [options] Optional Parameters.
Expand Down Expand Up @@ -2290,8 +2290,8 @@ function _createImagesFromUrls(projectId, batch, options, callback) {
*
* @param {uuid} projectId The project id.
*
* @param {object} batch Image and tag ids. Limted to 64 images and 20 tags per
* batch.
* @param {object} batch Image and tag ids. Limited to 64 images and 20 tags
* per batch.
*
* @param {array} [batch.images]
*
Expand Down Expand Up @@ -6566,7 +6566,7 @@ class TrainingAPIClient extends ServiceClient {
*
* @param {array} imageIds Image ids. Limited to 64 images.
*
* @param {array} tagIds Tags to be deleted from the specified images. Limted
* @param {array} tagIds Tags to be deleted from the specified images. Limited
* to 20 tags.
*
* @param {object} [options] Optional Parameters.
Expand Down Expand Up @@ -6601,7 +6601,7 @@ class TrainingAPIClient extends ServiceClient {
*
* @param {array} imageIds Image ids. Limited to 64 images.
*
* @param {array} tagIds Tags to be deleted from the specified images. Limted
* @param {array} tagIds Tags to be deleted from the specified images. Limited
* to 20 tags.
*
* @param {object} [options] Optional Parameters.
Expand Down Expand Up @@ -7278,7 +7278,7 @@ class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {array} imageIds Ids of the images to be deleted. Limted to 256
* @param {array} imageIds Ids of the images to be deleted. Limited to 256
* images per batch.
*
* @param {object} [options] Optional Parameters.
Expand Down Expand Up @@ -7311,7 +7311,7 @@ class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {array} imageIds Ids of the images to be deleted. Limted to 256
* @param {array} imageIds Ids of the images to be deleted. Limited to 256
* images per batch.
*
* @param {object} [options] Optional Parameters.
Expand Down Expand Up @@ -7572,8 +7572,8 @@ class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {object} batch Image and tag ids. Limted to 64 images and 20 tags per
* batch.
* @param {object} batch Image and tag ids. Limited to 64 images and 20 tags
* per batch.
*
* @param {array} [batch.images]
*
Expand Down Expand Up @@ -7612,8 +7612,8 @@ class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {object} batch Image and tag ids. Limted to 64 images and 20 tags per
* batch.
* @param {object} batch Image and tag ids. Limited to 64 images and 20 tags
* per batch.
*
* @param {array} [batch.images]
*
Expand Down