Describe a Model

GET

api

projects

{projectName}

models

{modelName}

describe

curl --request GET \
  --url http://127.0.0.1:47334/api/projects/{projectName}/models/{modelName}/describe \
  --header 'Content-Type: application/json' \
  --data '{
  "attribute": "<string>"
}'

[
    {
        "accuracies": {
            "r2_score": 0.999
        },
        "column_importances": {
            "days_on_market": 0.116,
            "location": 0.054,
            "neighborhood": 0.0,
            "number_of_bathrooms": 0.009,
            "number_of_rooms": 0.297,
            "sqft": 1.037
        },
        "inputs": [
            "number_of_rooms",
            "number_of_bathrooms",
            "sqft",
            "location",
            "days_on_market",
            "neighborhood"
        ],
        "model": "encoders --> dtype_dict --> dependency_dict --> model --> problem_definition --> identifiers --> imputers --> accuracy_functions",
        "outputs": [
            "rental_price"
        ]
    }
]

[
    {
        "accuracies": {
            "r2_score": 0.999
        },
        "column_importances": {
            "days_on_market": 0.116,
            "location": 0.054,
            "neighborhood": 0.0,
            "number_of_bathrooms": 0.009,
            "number_of_rooms": 0.297,
            "sqft": 1.037
        },
        "inputs": [
            "number_of_rooms",
            "number_of_bathrooms",
            "sqft",
            "location",
            "days_on_market",
            "neighborhood"
        ],
        "model": "encoders --> dtype_dict --> dependency_dict --> model --> problem_definition --> identifiers --> imputers --> accuracy_functions",
        "outputs": [
            "rental_price"
        ]
    }
]

The REST API endpoints can be used with MindsDB running locally at http://127.0.0.1:47334/api.

Path Parameters

projectName

string

required

The name of the project

modelName

string

required

The name of the model

Body

application/json

attribute

string

Attribute of the model to describe. See our DESCRIBE documentation. E.g. info, features, model

Response

200

application/json

A JSON object with model informations

The response is of type object.

Was this page helpful?

Suggest edits Raise issue

List Models Get a Model

curl --request GET \
  --url http://127.0.0.1:47334/api/projects/{projectName}/models/{modelName}/describe \
  --header 'Content-Type: application/json' \
  --data '{
  "attribute": "<string>"
}'

[
    {
        "accuracies": {
            "r2_score": 0.999
        },
        "column_importances": {
            "days_on_market": 0.116,
            "location": 0.054,
            "neighborhood": 0.0,
            "number_of_bathrooms": 0.009,
            "number_of_rooms": 0.297,
            "sqft": 1.037
        },
        "inputs": [
            "number_of_rooms",
            "number_of_bathrooms",
            "sqft",
            "location",
            "days_on_market",
            "neighborhood"
        ],
        "model": "encoders --> dtype_dict --> dependency_dict --> model --> problem_definition --> identifiers --> imputers --> accuracy_functions",
        "outputs": [
            "rental_price"
        ]
    }
]