Merge pull request #158 from ainize-team/release/1.3.6

Upgrade version to 1.3.6
ainize-team · Dec 19, 2024 · 1f99155 · 1f99155
2 parents 16bf3cd + b4aeb67
commit 1f99155
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,7 @@ yarn add @ainize-team/ainize-js
 ```
 
 Then import the libraries in your code:
+
 ```typescript
 // ES6
 import Ainize from '@ainize-team/ainize-js';
@@ -25,9 +26,6 @@ import Ainize from '@ainize-team/ainize-js';
 const Ainize = require('@ainize-team/ainize-js').default;
 ```
 
-
-## Usage
-
 ### Create account
 
 You should login to ainize with AI Network account before deploy the container.\
@@ -45,6 +43,7 @@ console.log(wallet);
 ```
 
 ### Login
+
 ```typescript
 import Ainize from '@ainize-team/ainize-js';
 const ainize = new Ainize(1);// 0 for testnet, 1 for mainnet. You can earn testnet AIN at https://faucet.ainetwork.ai/.
@@ -91,23 +90,27 @@ main();
 ```
 
 ### Currently supported models
+
 | Model    | MODEL_NAME | Insight Link |
 | -------- | ------- | ------- |
 | LLaMA 3.1 8B  | meta-llama/Llama-3.1-8B-instruct | [Link](https://insight.ainetwork.ai/database/values/apps/meta_llama_llama_3_1_8b_instruct/) |
 
-<!--
 ### Deploy
 
-You can deploy your AI model to ainize. Anyone can use your AI model with AIN token.
+You can deploy your AI model to ainize. Anyone can use your AI model with AIN token. **You need AIN tokens for deploying models.**
 
 CONFIGURATION(JSON)
 
 - modelName: The name you want to deploying model.
+- modelUrl: Inference URL wrapped with ainize-wrapper-server.
+
+<!--
 - billingConfig: Billing configuration required for model usage.
   - depositAddress: The address for receiving AIN deposits.
   - costPerToken: Cost per token for model usage.
   - minCost: Minimum cost.
   - maxCost: Maximum cost. (optional)
+-->
 
 ```typescript
 import { Ainize } from '@ainize-team/ainize-js';
@@ -118,23 +121,24 @@ const main = async () => {
     const ainize = new Ainize(1);
     await ainize.login(ainPrivateKey);
     const deployConfig = {
-      modelName: 'YOUR_MODEL_NAME',// e.g. meta-llama/Llama-3.1-8B-instruct
-      modelUrl: 'YOUR_MODEL_INFERENCE_URL' // e.g. https://ainize-free-inference.ainetwork.xyz
+      modelName: 'YOUR_MODEL_NAME', // e.g. meta-llama/Llama-3.1-8B-instruct
+      modelUrl: 'https://ainize-free-inference.ainetwork.xyz' // This URL is for tutorial.
     }
     const model = await ainize.deploy(deployConfig);
     console.log(model.modelName);
     ainize.logout();
-  }catch(e) {
+  } catch(e) {
     console.log(e);
   }
 }
 main();
 ```
 
+<!--
 You can stop or run your model container. Only model deployer can use this.
 
 ```typescript
 model.stop();
 model.run();
-```
 -->
+```
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ainize-team/ainize-js",
-  "version": "1.3.5",
+  "version": "1.3.6",
   "main": "dist/ainize.js",
   "types": "dist/ainize.d.ts",
   "scripts": {

diff --git a/src/constants.ts b/src/constants.ts
@@ -20,10 +20,10 @@ export const Path = {
       depositOfUser: (userAddress: string) => `${Path.app(appName).deposit()}/${userAddress}`,
       billingConfig: () => `${Path.app(appName).root()}/billingConfig`,
       model: () => `${Path.app(appName).root()}/model`,
-      userOfModel: (userAddress: string) => 
+      requestUser: (userAddress: string) => 
         `${Path.app(appName).model()}/${userAddress}`,
       requestKey: (userAddress: string, requestKey: string) => 
-        `${Path.app(appName).userOfModel(userAddress)}/${requestKey}`,
+        `${Path.app(appName).requestUser(userAddress)}/${requestKey}`,
       request: (userAddress: string, requestKey: string) => 
         `${Path.app(appName).requestKey(userAddress, requestKey)}/request`,
       response: (userAddress: string, requestKey: string) => 
@@ -65,17 +65,28 @@ export const defaultAppRules = (appName: string): { [type: string]: { ref: strin
         },
       },
     },
-    // requestKey: {
-    //   ref: Path.app(appName).requestKey("$userAddress", "$requestKey"),
-    //   value: {
-    //     ".rule": {
-    //       state: {
-    //         gc_max_siblings: 20,
-    //         gc_num_siblings_deleted: 10,
-    //       },
-    //     },
-    //   }
-    // },
+    requestUser: {
+      ref: Path.app(appName).requestUser("$userAddress"),
+      value: {
+        ".rule": {
+          state: {
+            gc_max_siblings: 50,
+            gc_num_siblings_deleted: 10,
+          },
+        }
+      }
+    },
+    requestKey: {
+      ref: Path.app(appName).requestKey("$userAddress", "$requestKey"),
+      value: {
+        ".rule": {
+          state: {
+            gc_max_siblings: 20,
+            gc_num_siblings_deleted: 10,
+          },
+        },
+      }
+    },
     request: {
       ref: Path.app(appName).request("$userAddress", "$requestKey"),
       value: {