Skip to content

Commit a951add

Browse files
authored
docs(ui-tars): update name for VLM (#517)
1 parent 6e3204a commit a951add

File tree

7 files changed

+38
-8
lines changed

7 files changed

+38
-8
lines changed
84.2 KB
Loading
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
/*
2+
* Copyright (c) 2025 Bytedance, Inc. and its affiliates.
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
import { describe, it, expect } from 'vitest';
6+
import { VLMProviderV2 } from './types';
7+
8+
describe('VLMProviderV2', () => {
9+
it('should have correct values for each provider', () => {
10+
const cases = [
11+
[VLMProviderV2.ui_tars_1_0, 'Hugging Face for UI-TARS-1.0'],
12+
[VLMProviderV2.ui_tars_1_5, 'Hugging Face for UI-TARS-1.5'],
13+
[VLMProviderV2.doubao_1_5, 'VolcEngine Ark for Doubao-1.5-UI-TARS'],
14+
];
15+
16+
cases.forEach(([provider, expected]) => {
17+
expect(provider).toBe(expected);
18+
});
19+
});
20+
it('should have correct value for Doubao provider', () => {
21+
expect(VLMProviderV2.doubao_1_5).toBe(
22+
'VolcEngine Ark for Doubao-1.5-UI-TARS',
23+
);
24+
});
25+
26+
it('should contain exactly three providers', () => {
27+
const providerCount = Object.keys(VLMProviderV2).length;
28+
expect(providerCount).toBe(3);
29+
});
30+
});

apps/ui-tars/src/main/store/types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ export enum VlmProvider {
4141
}
4242

4343
export enum VLMProviderV2 {
44-
ui_tars_1_0 = 'OpenAI compatible for UI-TARS-1.0',
45-
ui_tars_1_5 = 'OpenAI compatible for UI-TARS-1.5',
44+
ui_tars_1_0 = 'Hugging Face for UI-TARS-1.0',
45+
ui_tars_1_5 = 'Hugging Face for UI-TARS-1.5',
4646
doubao_1_5 = 'VolcEngine Ark for Doubao-1.5-UI-TARS',
4747
}
4848

docs/preset.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ graph TD
6565
```yaml
6666
name: UI TARS Desktop Example Preset
6767
language: en
68-
vlmProvider: OpenAI compatible for UI-TARS-1.5
68+
vlmProvider: Hugging Face for UI-TARS-1.5
6969
vlmBaseUrl: https://your-endpoint.huggingface.cloud/v1
7070
vlmApiKey: your_api_key
7171
vlmModelName: your_model_name

docs/quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,14 @@ You can download the [latest release](https://github.com/bytedance/UI-TARS-deskt
6363
6464
```yaml
6565
Language: en
66-
VLM Provider: OpenAI compatible for UI-TARS-1.5
66+
VLM Provider: Hugging Face for UI-TARS-1.5
6767
VLM Base URL: https:xxx
6868
VLM API KEY: hf_xxx
6969
VLM Model Name: xxx
7070
```
7171
7272
> [!NOTE]
73-
> For VLM Provider, make sure to select "**OpenAI compatible for UI-TARS-1.5**" to ensure proper VLM Action parsing.
73+
> For VLM Provider, make sure to select "**Hugging Face for UI-TARS-1.5**" to ensure proper VLM Action parsing.
7474
7575
<img src="../apps/ui-tars/images/quick_start/huggingface_setting.png" width="500px" />
7676

docs/setting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Select the backend VLM provider to ensure more accurate execution of GUI actions
4141
| Property | Details |
4242
| ----------- | ---------------------- |
4343
| **Type** | `string` |
44-
| **Options** | - `OpenAI compatible for UI-TARS-1.0`<br /> - `OpenAI compatible for UI-TARS-1.5`<br /> - `VolcEngine Ark for Doubao-1.5-UI-TARS` |
44+
| **Options** | - `Hugging Face for UI-TARS-1.0`<br /> - `Hugging Face for UI-TARS-1.5`<br /> - `VolcEngine Ark for Doubao-1.5-UI-TARS` |
4545
| **Required** | `true` |
4646

4747
> [!NOTE]
@@ -100,7 +100,7 @@ In the HuggingFace example in [UI-TARS/README_deploy.md](https://github.com/byte
100100

101101
```yaml
102102
Language: en
103-
VLM Provider: OpenAI compatible for UI-TARS-1.5
103+
VLM Provider: Hugging Face for UI-TARS-1.5
104104
VLM Base URL: https:xxx
105105
VLM API KEY: hf_xxx
106106
VLM Model Name: tgi

examples/presets/default.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: UI TARS Desktop Example Preset
22
language: en
3-
vlmProvider: OpenAI compatible for UI-TARS-1.5
3+
vlmProvider: Hugging Face for UI-TARS-1.5
44
vlmBaseUrl: https://your-endpoint.huggingface.cloud/v1
55
vlmApiKey: your_api_key
66
vlmModelName: your_model_name

0 commit comments

Comments
 (0)