Comment on page
View a Project Version
Get information about a project version using the API
You can retrieve information about a Roboflow project using the Python SDK, REST API, and CLI.
Python
REST API
CLI
To retrieve information about a project, use this command:
import roboflow
rf = roboflow.Roboflow(api_key=YOUR_API_KEY_HERE)
# get a project
project = rf.workspace().project("PROJECT_ID")
model = project.version("1").model
The
model variable contains the following JSON values:{
"id": "mug-detector-eocwp/12",
"name": "Mug Detector",
"version": "12",
"classes": null,
"overlap": 30,
"confidence": 40,
"stroke": 1,
"labels": false,
"format": "json",
"base_url": "https://detect.roboflow.com/"
}
If you already know which project and version you want to retrieve information about, you can use the
/:workspace/:project/:version endpoint. It returns similar information as the project endpoint but does not enumerate all of the project's other versions.To retrieve information about a project, make a GET request to the following endpoint:
https://api.roboflow.com/roboflow/chess-sample-4ckfl/1?api_key=$ROBOFLOW_API_KEY
This endpoint returns the following response:
{
"workspace": {
"name": "Roboflow",
"url": "roboflow",
"members": 7
},
"project": {
"id": "roboflow/chess-sample-4ckfl",
"type": "object-detection",
"name": "Chess Sample",
"created": 1630335544.592,
"updated": 1630335741.988,
"images": 12,
"unannotated": 3,
"annotation": "pieces",
"public": false,
"splits": {
"test": 1,
"valid": 2,
"train": 9
},
"classes": {
"black-knight": 11,
"black-queen": 4,
"black-king": 8,
"white-king": 8,
"white-pawn": 34,
"black-bishop": 8,
"white-rook": 10,
"black-pawn": 37,
"white-knight": 10,
"white-bishop": 11,
"black-rook": 10,
"white-queen": 7
}
},
"version": {
"id": "roboflow/chess-sample-4ckfl/1",
"name": "augmented",
"created": 1630335698.746,
"images": 30,
"splits": {
"valid": 2,
"test": 1,
"train": 27
},
"model": {
"id": "chess-sample-4ckfl/1",
"endpoint": "https://detect.staging.roboflow.com/chess-sample-4ckfl/1",
"start": 1630335799.682,
"end": 1630337523.889,
"fromScratch": false,
"tfjs": true,
"oak": true,
"map": "62.87",
"recall": "85.29",
"precision": "23.44"
},
"preprocessing": {
"resize": {
"height": 416,
"width": 416,
"format": "Stretch to",
"enabled": true
},
"auto-orient": {
"enabled": true
},
"grayscale": {
"enabled": true
}
},
"augmentation": {
"rotate": {
"degrees": "5",
"enabled": true
},
"brightness": {
"darken": true,
"enabled": true,
"brighten": true,
"percent": "25"
},
"noise": {
"percent": "2",
"enabled": true
},
"crop": {
"enabled": true,
"min": 0,
"percent": 30
},
"flip": {
"horizontal": true,
"vertical": false,
"enabled": true
},
"image": {
"versions": "3",
"enabled": true
},
"exposure": {
"enabled": true,
"percent": "25"
}
},
"exports": [
"yolov5pytorch"
],
"train": {
"status": "finished",
"results": {
"class_map": {
"valid": [
{
"images": "20",
"map95": "0.29",
"precision": "0.795",
"recall": "0.48",
"map50": "0.547",
"class": "all",
"targets": "82"
},
...
],
"test": [
{
"images": "10",
"map95": "0.478",
"precision": "0.846",
"recall": "0.759",
"map50": "0.844",
"class": "all",
"targets": "29"
},
...
]
}
}
},
"models": {
"roboflow-train": {
"epochs": [
{
"mAP": "0.5624740875589795",
"epoch": "0",
"precision": "0.848007354583702",
"recall": "0.4796292117720689",
"box_loss": "0.04430354",
"obj_loss": "0.023823218",
"class_loss": "0.012277425",
"mAP_50_95": "0.3004394102727502"
},
{
"mAP": "0.5576528999996365",
"epoch": "1",
"precision": "0.8477760345230224",
"recall": "0.47967238365789094",
"box_loss": "0.041422606",
"obj_loss": "0.020020777",
"class_loss": "0.010422977",
"mAP_50_95": "0.2943194093111112"
},
...
]
}
}
}
}
To retrieve information about a project using the CLI, you can use the following command:
roboflow project get <project-id>
For more details regarding this CLI command, please refer to the
roboflow project get section of the CLI docs.Last modified 8d ago