You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- aitk.modelInfo.id: a unique name in aitk. Usually huggingface/ORG/MODEL_NAME
78
-
- aitk.modelInfo.version: when config or inference sample has breaking updates, increase this number and AITK will ask user to upgrade their recipes. Start from 1.
77
+
- aitk.modelInfo.id: a unique name in Foundry Toolkit. Usually huggingface/ORG/MODEL_NAME
78
+
- aitk.modelInfo.version: when config or inference sample has breaking updates, increase this number and Foundry Toolkit will ask user to upgrade their recipes. Start from 1.
79
79
- aitk.modelInfo.groupId: (optional) If we want to group multiple models together like for different size, we could set it
80
80
- aitk.modelInfo.groupItemName: (optional) the name shown in dropdown
81
81
@@ -93,15 +93,15 @@ When we are updating the project, we may need to increase version. See [Versioni
93
93
94
94
Version is designed to be an increasing integer for model scope to simplify version management.
95
95
96
-
For end user, the version could bump more than 1 between each AITK update because AITK release and recipe update are two different processes. This is transparent to end user and they just see update no matter the gap is.
96
+
For end user, the version could bump more than 1 between each Foundry Toolkit update because Foundry Toolkit release and recipe update are two different processes. This is transparent to end user and they just see update no matter the gap is.
97
97
98
98
## Run sanitize.py
99
99
100
-
Run .aitk/scripts/sanitize.py to config and generate AITK specific files. These files are optional for pr creator as they are auto-generated (but need to commit for AITK).
100
+
Run .aitk/scripts/sanitize.py to config and generate Foundry Toolkit specific files. These files are optional for pr creator as they are auto-generated (but need to commit for Foundry Toolkit).
101
101
102
102
- checks.json: sanity check for changes
103
103
- model_list.json: you could see that new model is correctly added
104
-
- .gitignore: default pattern for AITK project files
104
+
- .gitignore: default pattern for Foundry Toolkit project files
105
105
- model_project.config: list recipes same as info.yml
106
106
- xxx.json.config: UX definition file for xxx.json. Automatically generated for llm model now
107
107
- For new recipes, we may need to work together for generation
@@ -110,7 +110,7 @@ You could also see warnings for your project:
110
110
111
111
- requirements.txt not exists: This file is optional. If provided, we will install the packages in it in our default venv. The purpose of this file is to enable user to add packages he needed for updated inference sample or olive json
112
112
- This file is not the config for conversion or inference venv
113
-
- inference_model.json not exists: this is for adding converted model to AITK catalog. If tested, we could add that
113
+
- inference_model.json not exists: this is for adding converted model to Foundry Toolkit catalog. If tested, we could add that
114
114
115
115
Now the changed files are
116
116
@@ -120,17 +120,17 @@ Now the changed files are
120
120
121
121
[UxConfig.md](./UxConfig.md)
122
122
123
-
## Test in AITK
123
+
## Test in Foundry Toolkit
124
124
125
-
Run `.aitk/scripts/pack_to_extension.py` and it will pack current local olive-recipes repo into installed AITK extension. So you could test in your local branch first before pushing to olive-recipes.
125
+
Run `.aitk/scripts/pack_to_extension.py` and it will pack current local olive-recipes repo into installed Foundry Toolkit extension. So you could test in your local branch first before pushing to olive-recipes.
126
126
127
-
After the script, reopen VS Code to restart the AITK, you should see it in the model list
127
+
After the script, reopen VS Code to restart the Foundry Toolkit, you should see it in the model list
128
128
129
129

130
130
131
-
It will be converted via your specified environment and run in current WCR environment from AITK.
131
+
It will be converted via your specified environment and run in current WCR environment from Foundry Toolkit.
132
132
133
-
### Test in AITK source code
133
+
### Test in Foundry Toolkit source code
134
134
135
135
Run `npm run zip-template`. It will pack olive-recipes into windows-ai-studio-templates first then pack windows-ai-studio-templates into resources/template.zip for extension debugging.
Copy file name to clipboardExpand all lines: .aitk/docs/guide/ProjectUpdate.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,15 +3,15 @@
3
3
When your project needs update, it means that
4
4
5
5
- We have updated the olive json or inference sample that is not compatible with previous version
6
-
- The config file version inside AITK is different from your project.
6
+
- The config file version inside Foundry Toolkit is different from your project.
7
7
8
8
## What should you do
9
9
10
10
Basically you have 3 options
11
11
12
12
- Replace your project with latest project automatically
13
13
- Create a new project and migrate your changes into that project
14
-
- Downgrade AITK to continue use previous version
14
+
- Downgrade Foundry Toolkit to continue use previous version
15
15
16
16
### Replace your project with latest project automatically
17
17
@@ -23,7 +23,7 @@ This is recommended when you have changes. You could either migrate your changes
23
23
24
24
The reverse direction is more complex but you may be still able to use olive cache.
25
25
26
-
### Downgrade AITK to continue use previous version
26
+
### Downgrade Foundry Toolkit to continue use previous version
27
27
28
28
It is a workaround, but it will not allow you to use new recipes or new features.
29
29
@@ -35,6 +35,6 @@ The UX for showing the parameters may not working and in this case, you could ch
35
35
36
36
## About version
37
37
38
-
When you see the version, you may notice that they are not continuous. This is caused by AITK release and recipe update are two different processes.
38
+
When you see the version, you may notice that they are not continuous. This is caused by Foundry Toolkit release and recipe update are two different processes.
39
39
40
-
The recipes could be updated multiple times between two AITK releases.
40
+
The recipes could be updated multiple times between two Foundry Toolkit releases.
0 commit comments