Skip to content

Commit c48c78c

Browse files
Update docstrings (#1004)
* Update docstrings * Update docstrings in d.ts * newline * update
1 parent 129368c commit c48c78c

File tree

1 file changed

+25
-11
lines changed

1 file changed

+25
-11
lines changed

src/index.d.ts

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1224,14 +1224,20 @@ declare namespace admin.machineLearning {
12241224

12251225
/**
12261226
* A TensorFlow Lite Model output object
1227+
*
1228+
* One of either the `gcsTfliteUri` or `automlModel` properties will be
1229+
* defined.
12271230
*/
12281231
interface TFLiteModel {
12291232
/** The size of the model. */
12301233
readonly sizeBytes: number;
12311234

12321235
/** The URI from which the model was originally provided to Firebase. */
12331236
readonly gcsTfliteUri?: string;
1234-
/** The AutoML URI from which the model was originally provided to Firebase. */
1237+
/**
1238+
* The AutoML model reference from which the model was originally provided
1239+
* to Firebase.
1240+
*/
12351241
readonly automlModel?: string;
12361242
}
12371243

@@ -1242,10 +1248,16 @@ declare namespace admin.machineLearning {
12421248
/** The ID of the model. */
12431249
readonly modelId: string;
12441250

1245-
/** The model's name. This is the name you use from your app to load the model. */
1251+
/**
1252+
* The model's name. This is the name you use from your app to load the
1253+
* model.
1254+
*/
12461255
readonly displayName: string;
12471256

1248-
/** The model's tags. */
1257+
/**
1258+
* The model's tags, which can be used to group or filter models in list
1259+
* operations.
1260+
*/
12491261
readonly tags?: string[];
12501262

12511263
/** The timestamp of the model's creation. */
@@ -1314,7 +1326,7 @@ declare namespace admin.machineLearning {
13141326
* state.published = true
13151327
* ```
13161328
*
1317-
* See https://firebase.google.com/docs/ml-kit/manage-hosted-models#list_your_projects_models
1329+
* See https://firebase.google.com/docs/ml/manage-hosted-models#list_your_projects_models
13181330
*/
13191331
filter?: string;
13201332

@@ -1352,7 +1364,7 @@ declare namespace admin.machineLearning {
13521364
app: admin.app.App;
13531365

13541366
/**
1355-
* Creates a model in Firebase ML.
1367+
* Creates a model in the current Firebase project.
13561368
*
13571369
* @param {ModelOptions} model The model to create.
13581370
*
@@ -1361,7 +1373,7 @@ declare namespace admin.machineLearning {
13611373
createModel(model: ModelOptions): Promise<Model>;
13621374

13631375
/**
1364-
* Updates a model in Firebase ML.
1376+
* Updates a model's metadata or model file.
13651377
*
13661378
* @param {string} modelId The ID of the model to update.
13671379
* @param {ModelOptions} model The model fields to update.
@@ -1371,7 +1383,9 @@ declare namespace admin.machineLearning {
13711383
updateModel(modelId: string, model: ModelOptions): Promise<Model>;
13721384

13731385
/**
1374-
* Publishes a model in Firebase ML.
1386+
* Publishes a Firebase ML model.
1387+
*
1388+
* A published model can be downloaded to client apps.
13751389
*
13761390
* @param {string} modelId The ID of the model to publish.
13771391
*
@@ -1380,7 +1394,7 @@ declare namespace admin.machineLearning {
13801394
publishModel(modelId: string): Promise<Model>;
13811395

13821396
/**
1383-
* Unpublishes a model in Firebase ML.
1397+
* Unpublishes a Firebase ML model.
13841398
*
13851399
* @param {string} modelId The ID of the model to unpublish.
13861400
*
@@ -1389,7 +1403,7 @@ declare namespace admin.machineLearning {
13891403
unpublishModel(modelId: string): Promise<Model>;
13901404

13911405
/**
1392-
* Gets a model from Firebase ML.
1406+
* Gets the model specified by the given ID.
13931407
*
13941408
* @param {string} modelId The ID of the model to get.
13951409
*
@@ -1398,7 +1412,7 @@ declare namespace admin.machineLearning {
13981412
getModel(modelId: string): Promise<Model>;
13991413

14001414
/**
1401-
* Lists models from Firebase ML.
1415+
* Lists the current project's models.
14021416
*
14031417
* @param {ListModelsOptions} options The listing options.
14041418
*
@@ -1410,7 +1424,7 @@ declare namespace admin.machineLearning {
14101424
listModels(options?: ListModelsOptions): Promise<ListModelsResult>;
14111425

14121426
/**
1413-
* Deletes a model from Firebase ML.
1427+
* Deletes a model from the current project.
14141428
*
14151429
* @param {string} modelId The ID of the model to delete.
14161430
*/

0 commit comments

Comments
 (0)