diff --git a/docs/document-scanner/options.md b/docs/document-scanner/options.md index 96edd2af..1cf1450c 100644 --- a/docs/document-scanner/options.md +++ b/docs/document-scanner/options.md @@ -5,16 +5,16 @@ title: Options # Document Scanner Options -A `DocumentScannerOptions` object is used to configure the behavior of the document scanner. This interface provides several optional properties that allow you to enable or disable certain features, set the mode of the scanner and choose the format for the results. +A `DocumentScannerOptions` object is used to configure the behavior of the document scanner. This interface provides +several optional properties that allow you to enable or disable certain features, set the mode of the scanner and choose +the format for the results. | Property | Type | Optional | Description | -|--:---------------------|--:--------------------|----------|--:----------------------------------------------------------------------| +|------------------------|-----------------------|----------|-------------------------------------------------------------------------| | `pageLimit` | `number` | Yes | The maximum number of pages that can be scanned. | | `galleryImportAllowed` | `boolean` | Yes | Allow the user to choose images from gallery or force a new photograph. | | `scannerMode` | `ScannerModeOptions` | Yes | Sets the mode of the scanner. | -| `resultFormats` | `ResultFormatOptions` | Yes | Sets the format of the scanned document results. | - - +| `resultFormats` | `ResultFormatOptions` | Yes | Sets the format of the scanned document results. | | For more information on these options see [the MLKit Docs](https://developers.google.com/ml-kit/vision/doc-scanner/android) diff --git a/docs/face-detection/options.md b/docs/face-detection/options.md index 57c015a1..87ec530a 100644 --- a/docs/face-detection/options.md +++ b/docs/face-detection/options.md @@ -34,13 +34,11 @@ function App() { Options for the face detector. -| Property | Description | Type | Default | -| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ---------- | ------ | -| `performanceMode` | The performance mode for the detector. Determines the trade-off between speed and accuracy. -Use `'fast'` for real-time applications where speed is critical, and `'accurate'` for applications where higher accuracy -is desired at the expense of speed. | `'fast'` \| `'accurate'` | `accurate` | -| `landmarkMode` | Indicates if landmark detection should be enabled. | `boolean | null` | `null` | -| `contourMode` | Indicates if contour detection should be enabled. | `boolean | null` | `null` | -| `classificationMode` | Indicates if classification mode should be enabled. | `boolean | null` | `null` | -| `minFaceSize` | Minimum size of the face for detection. | `number | null` | `null` | -| `isTrackingEnabled` | Indicates if tracking should be enabled for detected faces. | `boolean | null` | `null` | +| Property | Description | Type | Default | +|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|------------| +| `performanceMode` | The performance mode for the detector. Determines the trade-off between speed and accuracy. Use `'fast'` for real-time applications where speed is critical, and `'accurate'` for applications where higher accuracy is desired at the expense of speed. | `'fast' \| 'accurate'` | `accurate` | +| `landmarkMode` | Indicates if landmark detection should be enabled. | `boolean \| null` | `null` | +| `contourMode` | Indicates if contour detection should be enabled. | `boolean \| null` | `null` | +| `classificationMode` | Indicates if classification mode should be enabled. | `boolean \| null` | `null` | +| `minFaceSize` | Minimum size of the face for detection. | `number \| null` | `null` | +| `isTrackingEnabled` | Indicates if tracking should be enabled for detected faces. | `boolean \| null` | `null` | diff --git a/docs/face-detection/types.md b/docs/face-detection/types.md index 251d8fb9..68d598a7 100644 --- a/docs/face-detection/types.md +++ b/docs/face-detection/types.md @@ -9,40 +9,36 @@ sidebar_position: 400 Represents the result of the face detection process, containing an array of detected faces, a success flag, any potential errors, and the path to the image. -| Property | Description | Type | Default | -| ----------- | ----------------------------------------------- | --------------- | ------- | ------ | -| `faces` | Array of detected faces. | `RNMLKitFace[]` | - | -| `success` | Indicates if the face detection was successful. | `boolean` | - | -| `error` | Any potential errors during detection. | `string | null` | `null` | -| `imagePath` | Path to the image being processed. | `string` | - | +| Property | Description | Type | Default | +|-------------|-------------------------------------------------|------------------|---------| +| `faces` | Array of detected faces. | `RNMLKitFace[]` | - | +| `success` | Indicates if the face detection was successful. | `boolean` | - | +| `error` | Any potential errors during detection. | `string \| null` | `null` | +| `imagePath` | Path to the image being processed. | `string` | - | ## `RNMLKitFace` Details of each detected face, including frame, landmarks, contours, and various other properties. -| Property | Description | Type | Default | -| ---------------------------- | ----------------------------------------------------------- | ----------------------- | ------- | ------ | -| `frame` | Frame detailing the position and size of the detected -face. | `{x, y, width, height}` | - | -| `landmarks` | Array of landmarks on the face. | `RNMLKitFaceLandmark[]` | - | -| `contours` | Array of contours on the face. | `RNMLKitFaceContour[]` | - | -| `hasTrackingID` | Indicates if the face has a tracking ID. | `boolean` | - | -| `trackingID` | The tracking ID of the face, if available. | `number | null` | `null` | -| `hasHeadEulerAngleX` | Indicates if the head Euler angle X is available. | `boolean` | - | -| `headEulerAngleX` | The head Euler angle X of the face, if available. | `number | null` | `null` | -| `hasHeadEulerAngleY` | Indicates if the head Euler angle Y is available. | `boolean` | - | -| `headEulerAngleY` | The head Euler angle Y of the face, if available. | `number | null` | `null` | -| `hasHeadEulerAngleZ` | Indicates if the head Euler angle Z is available. | `boolean` | - | -| `headEulerAngleZ` | The head Euler angle Z of the face, if available. | `number | null` | `null` | -| `hasSmilingProbability` | Indicates if the smiling probability is available. | `boolean` | - | -| `smilingProbability` | The smiling probability of the face, if available. | `number | null` | `null` | -| `hasLeftEyeOpenProbability` | Indicates if the left eye open probability is -available. | `boolean` | - | -| `leftEyeOpenProbability` | The left eye open probability of the face, if available. | `number | null` | `null` | -| `hasRightEyeOpenProbability` | Indicates if the right eye open probability is -available. | `boolean` | - | -| `rightEyeOpenProbability` | The right eye open probability of the face, if -available. | `number | null` | `null` | +| Property | Description | Type | Default | +|------------------------------|-------------------------------------------------------------|-------------------------|---------| +| `frame` | Frame detailing the position and size of the detected face. | `{x, y, width, height}` | - | +| `landmarks` | Array of landmarks on the face. | `RNMLKitFaceLandmark[]` | - | +| `contours` | Array of contours on the face. | `RNMLKitFaceContour[]` | - | +| `hasTrackingID` | Indicates if the face has a tracking ID. | `boolean` | - | +| `trackingID` | The tracking ID of the face, if available. | `number \| null` | `null` | +| `hasHeadEulerAngleX` | Indicates if the head Euler angle X is available. | `boolean` | - | +| `headEulerAngleX` | The head Euler angle X of the face, if available. | `number \| null` | `null` | +| `hasHeadEulerAngleY` | Indicates if the head Euler angle Y is available. | `boolean` | - | +| `headEulerAngleY` | The head Euler angle Y of the face, if available. | `number \| null` | `null` | +| `hasHeadEulerAngleZ` | Indicates if the head Euler angle Z is available. | `boolean` | - | +| `headEulerAngleZ` | The head Euler angle Z of the face, if available. | `number \| null` | `null` | +| `hasSmilingProbability` | Indicates if the smiling probability is available. | `boolean` | - | +| `smilingProbability` | The smiling probability of the face, if available. | `number \| null` | `null` | +| `hasLeftEyeOpenProbability` | Indicates if the left eye open probability is available. | `boolean` | - | +| `leftEyeOpenProbability` | The left eye open probability of the face, if available. | `number \| null` | `null` | +| `hasRightEyeOpenProbability` | Indicates if the right eye open probability is available. | `boolean` | - | +| `rightEyeOpenProbability` | The right eye open probability of the face, if available. | `number \| null` | `null` | ## `FaceLandmarkType` @@ -76,10 +72,10 @@ Specific landmarks detected on a face. Specific contours detected on a face. -| Property | Description | Type | Default | -| -------- | ----------------------------------------------------- | ------------------------------ | ------- | ------ | -| `type` | Type of the contour. | `FaceContourType` | - | -| `points` | Array of points representing the contour on the face. | `Array<{x: number, y: number}> | null` | `null` | +| Property | Description | Type | Default | +|----------|-------------------------------------------------------|-----------------------------------------|---------| +| `type` | Type of the contour. | `FaceContourType` | - | +| `points` | Array of points representing the contour on the face. | `Array<{x: number, y: number}> \| null` | `null` | ## `FaceContourType` @@ -107,11 +103,12 @@ Types of contours that can be detected on a face. Options for the face detector. -| Property | Description | Type | Default | -| -------------------- | ----------------------------------------------------------- | -------- | ------- | ------ | -| `performanceMode` | The performance mode for the detector. | `string` | - | -| `landmarkMode` | Indicates if landmark detection should be enabled. | `boolean | null` | `null` | -| `contourMode` | Indicates if contour detection should be enabled. | `boolean | null` | `null` | -| `classificationMode` | Indicates if classification mode should be enabled. | `boolean | null` | `null` | -| `minFaceSize` | Minimum size of the face for detection. | `number | null` | `null` | -| `isTrackingEnabled` | Indicates if tracking should be enabled for detected faces. | `boolean | null` | `null` | +| Property | Description | Type | Default | +|----------------------|-------------------------------------------------------------|-------------------|---------| +| `performanceMode` | The performance mode for the detector. | `string` | - | +| `landmarkMode` | Indicates if landmark detection should be enabled. | `boolean \| null` | `null` | +| `contourMode` | Indicates if contour detection should be enabled. | `boolean \| null` | `null` | +| `classificationMode` | Indicates if classification mode should be enabled. | `boolean \| null` | `null` | +| `minFaceSize` | Minimum size of the face for detection. | `number \| null` | `null` | +| `isTrackingEnabled` | Indicates if tracking should be enabled for detected faces. | `boolean \| null` | `null` | + diff --git a/docs/image-labeling/index.md b/docs/image-labeling/index.md index 84e0b897..b316850b 100644 --- a/docs/image-labeling/index.md +++ b/docs/image-labeling/index.md @@ -15,7 +15,7 @@ apps. It allows for the classification of images to determine their content, suc ## Installation -``` +```shell npm install @infinitered/react-native-mlkit-image-labeling ```