muqtadar08/yolo – API reference

muqtadar08 / yolo

Public
59 runs

Run muqtadar08/yolo with an API

Use one of our client libraries to get started quickly. Clicking on a library will take you to the Playground tab where you can tweak different inputs, see the results, and copy the corresponding code to use in your own project.

Input schema

The fields you can use to run this model with an API. If you don't give a value for a field its default value will be used.

Field	Type	Default value	Description
input_image	string		Path to an image
model_name	string (enum)	yolox-s Options: yolox-s, yolox-m, yolox-l, yolox-x	Model name
conf	number	0.3 Max: 1	Confidence threshold: Only detections with confidence higher are kept
nms	number	0.3 Max: 1	NMS threshold: NMS removes redundant detections. Detections with overlap percentage (IOU) above this threshold are consider redundant to each other and only one of them will be kept
tsize	integer	640	Resize image to this size
return_json	boolean	False	Return results in json format

{
  "type": "object",
  "title": "Input",
  "required": [
    "input_image"
  ],
  "properties": {
    "nms": {
      "type": "number",
      "title": "Nms",
      "default": 0.3,
      "maximum": 1,
      "minimum": 0,
      "x-order": 3,
      "description": "NMS threshold: NMS removes redundant detections. Detections with overlap percentage (IOU) above this threshold are consider redundant to each other and only one of them will be kept"
    },
    "conf": {
      "type": "number",
      "title": "Conf",
      "default": 0.3,
      "maximum": 1,
      "minimum": 0,
      "x-order": 2,
      "description": "Confidence threshold: Only detections with confidence higher are kept"
    },
    "tsize": {
      "type": "integer",
      "title": "Tsize",
      "default": 640,
      "x-order": 4,
      "description": "Resize image to this size"
    },
    "model_name": {
      "enum": [
        "yolox-s",
        "yolox-m",
        "yolox-l",
        "yolox-x"
      ],
      "type": "string",
      "title": "model_name",
      "description": "Model name",
      "default": "yolox-s",
      "x-order": 1
    },
    "input_image": {
      "type": "string",
      "title": "Input Image",
      "format": "uri",
      "x-order": 0,
      "description": "Path to an image"
    },
    "return_json": {
      "type": "boolean",
      "title": "Return Json",
      "default": false,
      "x-order": 5,
      "description": "Return results in json format"
    }
  }
}

Output schema

The shape of the response you’ll get when you run this model with an API.

Schema

{
  "type": "object",
  "title": "Output",
  "properties": {
    "img": {
      "type": "string",
      "title": "Img",
      "format": "uri"
    },
    "json_str": {
      "type": "string",
      "title": "Json Str"
    }
  }
}