Skip to content

Commit b2a97a4

Browse files
authored
fix .get_model docs (#262)
1 parent 86e916d commit b2a97a4

File tree

2 files changed

+5
-9
lines changed

2 files changed

+5
-9
lines changed

nucleus/__init__.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -300,12 +300,11 @@ def get_model(
300300
"""Fetches a model by its ID.
301301
302302
Parameters:
303-
model_id: You can pass either a model ID (starts with ``prj_``) or a model run id (starts with ``run_``) This can
304-
be retrieved via :meth:`list_models` or a Nucleus dashboard URL. Model run ids result from the application of a model to a dataset.
305-
model_run_id: You can pass either a model ID (starts with ``prj_``), or a model run id (starts with ``run_``) This can
306-
be retrieved via :meth:`list_models` or a Nucleus dashboard URL. Model run ids result from the application of a model to a dataset.
303+
model_id: You can pass either a model ID (starts with ``prj_``) or a model run ID (starts with ``run_``) This can be retrieved via :meth:`list_models` or a Nucleus dashboard URL. Model run IDs result from the application of a model to a dataset.
304+
model_run_id: You can pass either a model ID (starts with ``prj_``), or a model run ID (starts with ``run_``) This can
305+
be retrieved via :meth:`list_models` or a Nucleus dashboard URL. Model run IDs result from the application of a model to a dataset.
307306
308-
In the future, we plan to hide model_run_ids fully from users.
307+
In the future, we plan to hide ``model_run_ids`` fully from users.
309308
310309
Returns:
311310
:class:`Model`: The Nucleus model as an object.

nucleus/dataset.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1217,10 +1217,7 @@ def calculate_evaluation_metrics(self, model, options: dict = None):
12171217
client = nucleus.NucleusClient("YOUR_SCALE_API_KEY")
12181218
dataset = client.get_dataset(dataset_id="YOUR_DATASET_ID")
12191219
1220-
model = client.get_model(
1221-
model_id="YOUR_MODEL_PRJ_ID",
1222-
dataset_id="YOUR_DATASET_ID"
1223-
)
1220+
model = client.get_model(model_id="YOUR_MODEL_PRJ_ID")
12241221
12251222
# Compute all evaluation metrics including IOU-based matching:
12261223
dataset.calculate_evaluation_metrics(model)

0 commit comments

Comments
 (0)