From edcc63250cc77b2dc234c915bba5f96f6a62cd53 Mon Sep 17 00:00:00 2001 From: Yoojin Ko Date: Tue, 31 Oct 2023 14:09:03 +0900 Subject: [PATCH] fix: module naming --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 78ed6ef..3d7d0a8 100644 --- a/README.md +++ b/README.md @@ -30,37 +30,37 @@ ainize.login(); ``` ### Deploy -You can deploy your AI model to ainize. +You can deploy your AI service to ainize. ```typescript -const model = await ainize.deploy(); +const service = await ainize.deploy(); ``` CONFIGURATION -- modelName: The name you want to deploying model. -- billingConfig: Billing configuration required for model usage. +- serviceName: The name you want to deploying service. +- billingConfig: Billing configuration required for service usage. - depositAddress: The address for receiving AIN deposits. - - costPerToken: Cost per token for model usage. + - costPerToken: Cost per token for service usage. - minCost: Minimum cost. - maxCost: Maximum cost. (optional) -You can stop or run your model container. Model deployer only can use this. +You can stop or run your service container. Only service deployer can use this. ```typescript -model.stop(); -model.run(); +service.stop(); +service.run(); ``` -### Using Model -You can use a model using `ainize.model()`. +### Using Service +You can use a service using `ainize.service()`. ```typescript -const model = await ainize.model(); +const service = await ainize.service(); ``` -You should deposit AIN to credit before using model. +You should deposit AIN to credit before using service. ```typescript -await model.deposit(); -const balance = await model.getCreditBalance(); +await service.chargeCredit(); +const balance = await service.getCreditBalance(); ``` -If you have enough credit, you can use the model. +If you have enough credit, you can use the service. ```typescript -const result = await model.use(); +const result = await service.use(); ```