Skip to content

Commit 7bc2eec

Browse files
authored
Feat/add quality options (#150)
* update dependencies * frame optimization mandarin version * fix en version
1 parent 2d9b38a commit 7bc2eec

File tree

98 files changed

+2251
-2123
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+2251
-2123
lines changed

docs/4-recipes/14-browser-support.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
sidebar_position: 14
3+
---
4+
5+
# 浏览器支持
6+
7+
刻行时空平台目前仅支持 Chrome 104 或更新的版本,请访问[Chrome 官方网站](https://www.google.cn/chrome/)获取最新版本。

docs/4-recipes/14-chrome-download.md

-44
This file was deleted.

docs/4-recipes/6-viz/10-create-moment-viz.md

+17-52
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,28 @@ sidebar_position: 10
33
---
44

55
# 在可视化界面中的一刻
6-
6+
77
「一刻」是记录中的关键帧,它可以是可视化界面中故障或有趣的画面
88

99
## 创建一刻
1010

1111
1. 点击记录中的【播放记录】按钮进入可视化界面
12-
12+
1313
![viz-9-1.png](../img/viz-9-1.png)
1414

1515
2. 点击左下角的【创建一刻】按钮,选择起止点
16-
如图,可使用快捷键或点击【创建一刻】按钮在需要的时间点确定起点
17-
16+
如图,可使用快捷键或点击【创建一刻】按钮在需要的时间点确定起点
17+
1818
![viz-9-2.png](../img/viz-9-2.png)
1919

2020
在需要的时间点再次点击确定终点,图示蓝色范围就是「一刻」的起止时间
2121

2222
![viz-9-3.png](../img/viz-9-3.png)
2323

24-
3. 可通过点击拖动更改「一刻」的范围
24+
3. 可通过点击拖动更改「一刻」的范围
2525
4. 输入名称,描述等字段信息完成创建
26-
27-
![viz-9-4.png](../img/viz-9-4.png)
2826

27+
![viz-9-4.png](../img/viz-9-4.png)
2928

3029
## 管理一刻
3130

@@ -34,67 +33,33 @@ sidebar_position: 10
3433
### 编辑一刻
3534

3635
点击图示编辑按钮修改「一刻」的字段信息
37-
38-
![viz-9-5.png](../img/viz-9-5.png)
36+
37+
![viz-9-5.png](../img/viz-9-5.png)
3938

4039
### 复制一刻
4140

4241
点击图示复制按钮来将当前「一刻」的链接复制到剪切板
43-
44-
![viz-9-6.png](../img/viz-9-6.png)
42+
43+
![viz-9-6.png](../img/viz-9-6.png)
4544

4645
### 删除一刻
4746

4847
点击图示删除按钮来删除这条「一刻」
49-
50-
![viz-9-7.png](../img/viz-9-7.png)
48+
49+
![viz-9-7.png](../img/viz-9-7.png)
5150

5251
## 查看一刻
5352

5453
1. 点击可视化页面顶部工具栏中的记录名称,前往记录详情页
55-
56-
![viz-9-8.png](../img/viz-9-8.png)
54+
55+
![viz-9-8.png](../img/viz-9-8.png)
5756

5857
2. 点击图示的【一刻】按钮
59-
60-
![viz-9-10.png](../img/viz-9-10.png)
58+
59+
![viz-9-10.png](../img/viz-9-10.png)
6160

6261
3. 进入一刻详情页,查看创建「一刻」的信息
6362

64-
![viz-9-11.png](../img/viz-9-11.png)
63+
![viz-9-11.png](../img/viz-9-11.png)
6564

6665
---
67-
68-
69-
70-
71-
72-
73-
74-
75-
76-
77-
78-
79-
80-
81-
82-
83-
84-
85-
86-
87-
88-
89-
90-
91-
92-
93-
94-
95-
96-
97-
98-
99-
100-
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
sidebar_position: 11
3+
---
4+
5+
# 帧率优化选项
6+
7+
「帧率优化选项」用于在数据量较大且带宽受限的情况下,通过主动调整 `topic` 数据的帧率来实现流畅的播放效果。
8+
9+
## 设置
10+
11+
![帧率设置界面](../img/4-6-frame-settings.png)
12+
13+
「帧率优化选项」位于可视化界面右下角,提供四个预设档位:
14+
15+
| 档位 | 目标帧率 |
16+
| ------ | ------------------------------ |
17+
| 原始值 | 保持原始数据帧率,不做任何处理 |
18+
|| 60 fps |
19+
|| 30 fps |
20+
|| 10 fps |
21+
22+
:::warning
23+
24+
以下类型的消息不会进行任何帧率的调整:
25+
26+
- `transform` 类型消息
27+
- 帧间存在依赖关系的数据(如 `CompressedVideo` 中的 `H.264` 编码视频流)
28+
29+
:::
30+
31+
## 规划中的进一步优化
32+
33+
现有方案对所有的 `topic` 进行统一的处理,有时候并不能满足所有用户的需求。
34+
35+
对此刻行已经在研发到 `topic` 级别的设置 未来将支持针对不同类型的 topic 采用不同的降帧策略。
36+
37+
### 自定义设置功能(规划中)
38+
39+
![自定义设置入口](../img/4-6-setting-per-topic-option.png)
40+
41+
通过自定义设置面板,用户可以:
42+
43+
- 为不同的 topic 独立配置帧率限制
44+
- 灵活调整数据采样频率
45+
46+
![自定义设置界面](../img/4-6-setting-per-topic-panel.png)
223 KB
Loading
Loading
Loading
-143 KB
Binary file not shown.
-300 KB
Binary file not shown.
-218 KB
Binary file not shown.
-132 KB
Binary file not shown.
-93.2 KB
Binary file not shown.
-63.2 KB
Binary file not shown.
-59.7 KB
Binary file not shown.

i18n/en/docusaurus-plugin-content-docs/current.json

+5-1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@
4343
"message": "Cloud Test",
4444
"description": "The label for category 批量测试 in sidebar tutorialSidebar"
4545
},
46+
"sidebar.tutorialSidebar.category.镜像": {
47+
"message": "Images",
48+
"description": "The label for category Images in sidebar tutorialSidebar"
49+
},
4650
"sidebar.tutorialSidebar.category.数据自动采集与诊断": {
4751
"message": "Data Collection and Diagnose",
4852
"description": "The label for category 数据自动采集与诊断 in sidebar tutorialSidebar"
@@ -83,4 +87,4 @@
8387
"message": "OpenAPI",
8488
"description": "The label for category 开放平台 OpenAPI in sidebar tutorialSidebar"
8589
}
86-
}
90+
}

i18n/en/docusaurus-plugin-content-docs/current/4-recipes/13-chrome-download.md

-9
This file was deleted.

i18n/en/docusaurus-plugin-content-docs/current/4-recipes/13-image/1-intro.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,26 @@
22
sidebar_position: 1
33
---
44

5-
# 关于镜像
5+
# About Images
66

7-
Docker 镜像是轻量级的、可执行的软件包,包含了运行某个软件或应用所需的所有内容——代码、运行时环境、库、环境变量和配置文件。Docker 镜像是构建 Docker 容器的基础,每个镜像都是不可变的,当运行镜像时,它会变成一个容器。
7+
Docker images are lightweight, executable software packages that contain everything needed to run a piece of software or application—code, runtime environment, libraries, environment variables, and configuration files. Docker images are the foundation for building Docker containers, and each image is immutable; when you run an image, it becomes a container.
88

9-
Docker 镜像的特点包括:
9+
Docker images have the following characteristics:
1010

11-
1. **分层存储**Docker 镜像由多层构成,每一层代表镜像构建过程中的一个步骤。当修改镜像时,只需添加新的层,不需要更改既有层,这使得镜像的分发和更新非常高效。
11+
1. **Layered Storage**: Docker images are composed of multiple layers, with each layer representing a step in the image building process. When modifying an image, you only need to add new layers without changing existing ones, making image distribution and updates highly efficient.
1212

13-
2. **共享与重用**:多个镜像可以共享相同的层,如果不同的镜像使用相同的基础层,那么这些层在机器上只需存储一份,可以节约空间并提高效率。
13+
2. **Sharing and Reuse**: Multiple images can share the same layers. If different images use the same base layers, these layers only need to be stored once on the machine, saving space and improving efficiency.
1414

15-
3. **不可变性**:镜像一旦创建,其内容就不可更改。所有对容器的修改(如添加新文件或更改现有文件)都将发生在容器的可写层,而不影响底层镜像。
15+
3. **Immutability**: Once created, an image's content cannot be changed. All modifications to containers (such as adding new files or changing existing ones) occur in the container's writable layer without affecting the underlying image.
1616

17-
4. **版本控制和回滚**Docker 镜像可以通过标签进行版本控制,方便管理和回滚到特定的版本。
17+
4. **Version Control and Rollback**: Docker images can be version-controlled through tags, making it easy to manage and roll back to specific versions.
1818

19-
5. **轻量级**:由于镜像是按需加载各个层,因此它们是轻量级的,启动速度快,便于快速扩展和分发。
19+
5. **Lightweight**: Since images load layers on demand, they are lightweight, start quickly, and are easy to scale and distribute.
2020

21-
6. **可移植性**:镜像包含了运行应用所需的所有依赖,可以在任何支持 Docker 的平台上运行,确保了一致的运行环境。
21+
6. **Portability**: Images contain all dependencies needed to run applications and can be executed on any platform that supports Docker, ensuring consistent runtime environments.
2222

23-
Docker 镜像通常从一个基础镜像开始构建,通过编写 Dockerfile(一个包含自定义指令集的文本文件)来定制镜像。这些自定义镜像可以存储在本地,也可以上传到公共或私有的镜像仓库(如 Docker Hub)中,供他人使用。使用 Docker 命令 `docker pull` 可以从仓库中拉取镜像到本地,`docker run` 命令则用于基于镜像启动一个新的容器。
23+
Docker images are typically built from a base image and customized through a Dockerfile (a text file containing custom instructions). These custom images can be stored locally or uploaded to public or private image registries (such as Docker Hub) for others to use. Docker images can be pulled from repositories to local machines using the `docker pull` command, and containers can be started from images using the `docker run` command.
2424

25-
# 关于刻行镜像仓库
25+
# About coScene Image Registry
2626

27-
刻行平台提供了一个私有的镜像仓库,让用户无须自行搭建,能够将现有的镜像快速的上传至刻行镜像仓库,从而立即可以在刻行平台使用相关的镜像,搭建业务流程,提升研发效率。如[自动化](../12-action/1-quickstart.md)[批量测试](../8-regression/1-intro.md)中均支持使用刻行镜像仓库镜像。
27+
The coScene platform provides a private image registry, eliminating the need for users to set up their own. Users can quickly upload existing images to the coScene image registry, enabling immediate use of these images on the coScene platform to build business processes and improve development efficiency. The coScene image registry is supported in features such as [Automation](../12-action/1-quickstart.md) and [Batch Testing](../8-regression/1-intro.md).

i18n/en/docusaurus-plugin-content-docs/current/4-recipes/13-image/2-build-image.md

+16-21
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,21 @@
22
sidebar_position: 2
33
---
44

5-
# 准备镜像
5+
# Preparing Images
66

7-
使用 Docker 构建自己的镜像。
7+
Using Docker to build your own images.
88

9-
## 前置条件
9+
## Prerequisites
1010

11-
本机已经安装并启动 Docker。若本机需要安装 Docker,请参考对应的[安装文档](https://docs.docker.com/engine/install/)
11+
Docker must be installed and running on your machine. If you need to install Docker, please refer to the corresponding [installation documentation](https://docs.docker.com/engine/install/).
1212

13-
## 准备镜像文件
13+
## Preparing Image Files
1414

15-
新建一个文件夹,其中包含 dockerfile 和相关的测试代码。下面以一个简单的名为 hello.py 的 Python 文件和 dockerfile 来进行演示。
15+
Create a new folder containing the dockerfile and related test code. Below is a demonstration using a simple Python file named hello.py and a dockerfile.
1616

17-
- 示例 dockerfile
17+
- Example dockerfile
1818

1919
```bash
20-
2120
FROM python:3.12 AS builder
2221

2322
# copy files
@@ -27,37 +26,33 @@ WORKDIR /usr/src/app
2726

2827
# set command/entrypoint, adapt to fit your needs
2928
CMD ["python", "hello.py"]
30-
3129
```
3230

33-
- 示例测试代码
31+
- Example test code
3432

3533
```python
3634
if __name__ == "__main__":
3735
print("Hello, World!")
38-
3936
```
4037

41-
## 打包镜像
38+
## Building the Image
4239

43-
我们假设镜像名字为 `cr.coscene.cn/coscene/helloworld`, 标签为 `latest`
40+
Let's assume the image name is `cr.coscene.cn/coscene/helloworld` with the tag `latest`
4441

4542
```bash
4643
docker build -f dockerfile -t cr.coscene.cn/coscene/helloword:latest .
47-
4844
```
49-
如果需要镜像支持不同的平台而进行交叉编译,具体请查看[文档](https://docs.docker.com/build/building/multi-platform/)
5045

51-
## 运行镜像
46+
If you need cross-compilation support for different platforms, please check the [documentation](https://docs.docker.com/build/building/multi-platform/)
5247

53-
镜像打包完成之后,我们可以运行镜像来验证一下代码功能。
48+
## Running the Image
5449

55-
```bash
56-
57-
docker run cr.coscene.cn/coscene/helloword:latest
50+
After the image is built, we can run it to verify the code functionality.
5851

52+
```bash
53+
docker run cr.coscene.cn/coscene/helloword:latest
5954
```
6055

61-
查看输出,镜像的打包正确,输出了我们的预期结果。
56+
Check the output - if the image was built correctly, it should show our expected result.
6257

6358
![](./img/build-image-1.png)

0 commit comments

Comments
 (0)