diff --git a/docs/docs/configuration/advanced.md b/docs/docs/configuration/advanced.md index a7e655e32..2b8b93f70 100644 --- a/docs/docs/configuration/advanced.md +++ b/docs/docs/configuration/advanced.md @@ -50,18 +50,28 @@ database: If using a custom model, the width and height will need to be specified. -Custom models may also require different input tensor formats. The colorspace conversion supports RGB, BGR, or YUV frames to be sent to the object detector. The input tensor shape parameter is a list of axis to let the detector reorder (transpose) the standard layout [BHWC] to match what specified by the model. +Custom models may also require different input tensor formats. The colorspace conversion supports RGB, BGR, or YUV frames to be sent to the object detector. The input tensor shape parameter is an enumeration to match what specified by the model. | Tensor Dimension | Description | | :--------------: | -------------- | -| B | Batch Size | +| N | Batch Size | | H | Model Height | | W | Model Width | | C | Color Channels | +| Available Input Tensor Shapes | +| :---------------------------: | +| "nhwc" | +| "nchw" | + ```yaml +# Optional: model config model: + path: /path/to/model + width: 320 + height: 320 input_tensor: "nhwc" + input_pixel_format: "bgr" ``` The labelmap can be customized to your needs. A common reason to do this is to combine multiple object types that are easily confused when you don't need to be as granular such as car/truck. By default, truck is renamed to car because they are often confused. You cannot add new object types, but you can change the names of existing objects in the model. diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index bd8a93be0..46933e271 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -100,7 +100,8 @@ model: # Optional: Object detection model input colorspace # Valid values are rgb, bgr, or yuv. (default: shown below) input_pixel_format: rgb - # Optional: Object detection model input tensor format (default: shown below) + # Optional: Object detection model input tensor format + # Valid values are nhwc or nchw (default: shown below) input_tensor: "nhwc" # Optional: Label name modifications. These are merged into the standard labelmap. labelmap: