Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .cursorrules
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
我们的创业公司叫刻行时空,英文名叫 coScene,请注意大小写,开头 c 为小写,除非在编程语言中有语义需要的大写开头,不然应保持小写。你是这个企业的专家智能体,在这个项目中,你将是一个文档专家的
角色,通过文字的形式,将企业的产品以通俗易懂的方式介绍给用户。

你了解刻行的产品、定位、会在文档中合适的地方使用刻行的专业术语
你了解刻行时空的产品、定位、会在文档中合适的地方使用刻行时空的专业术语

# Technical Details

Expand Down Expand Up @@ -37,7 +37,7 @@ Because we dont cut versions on our SaaS product hence no speicic versions, it w

1. ## 产品命名规范

由刻行官方核心解决方案一部分的完整产品,冠以 co 前缀,组成 coProduct 的产品名。在文档,网站,宣传材料等对外口径时,应使用 coProduct 作为统一格式。co 语义上引申自 coScene,如 coLink 的实际意义为 coScene Link。
由刻行时空官方核心解决方案一部分的完整产品,冠以 co 前缀,组成 coProduct 的产品名。在文档,网站,宣传材料等对外口径时,应使用 coProduct 作为统一格式。co 语义上引申自 coScene,如 coLink 的实际意义为 coScene Link。

在其余所有使用场景时,coproduct 作为**完整单词,不再进行分词**,避免混淆。在各场景遵循上下文惯例进行命名。

Expand Down
2 changes: 1 addition & 1 deletion docs/1-coscene-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ id: overview

### 自定义您的工作流

使用刻行时空的工作流引擎,您可以方便的在多模态场景数据上构建大规模的工作流应用而不用担心数据的准备和计算资源的调度。在工作流模版管理页面中,您不仅可以找到团队成员制作的工作流模版,也可以使用由刻行官方提供的处理各种数据类型的工作流模版
使用刻行时空的工作流引擎,您可以方便的在多模态场景数据上构建大规模的工作流应用而不用担心数据的准备和计算资源的调度。在工作流模版管理页面中,您不仅可以找到团队成员制作的工作流模版,也可以使用由刻行时空官方提供的处理各种数据类型的工作流模版

### 语义搜索引擎

Expand Down
2 changes: 1 addition & 1 deletion docs/_5-roadmap/1-roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ sidebar_position: 1

# 产品路线和计划

刻行正在紧锣密鼓的对产品进行不断的开发,每周我们都会有新的功能上线,我们会在这里不断的更新我们的产品路线图,让大家了解我们的产品规划。
刻行时空正在紧锣密鼓的对产品进行不断的开发,每周我们都会有新的功能上线,我们会在这里不断的更新我们的产品路线图,让大家了解我们的产品规划。

![123](img/roadmap.png)
33 changes: 20 additions & 13 deletions docs/collaboration/organization/1-organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,36 @@ sidebar_position: 1
---

# 组织

组织是一个逻辑概念,它代表了一个团队或者一个公司。组织可以拥有多个项目,也可以拥有多个成员。

## 组织管理界面

在「组织管理」页面,可以查看组织的项目、成员、设备、镜像、计费等信息。

| 名称 | 说明 |
| --- | --- |
| 项目 | 在项目列表中管理组织内所有项目。项目是数据管理的单元,详见[项目](../project-collaboration/1-project.md) |
| 成员 | 在成员列表中管理组织内的所有用户及其权限 |
| 设备 | 在组织设备列表中统一管理组织内所有设备。设备可以与真实设备建立联系,详见[设备](../../device/1-device.md) |
| 镜像 | 平台提供专业的私有镜像仓库,统一管理组织内所有镜像,详见[镜像](../../image/1-about-docker-image.md) |
| 用量与计费 | 展示组织的存储量、设备数、计算时长等信息 |
| 名称 | 说明 |
| ---------- | -------------------------------------------------------------------------------------------------------- |
| 项目 | 在项目列表中管理组织内所有项目。项目是数据管理的单元,详见[项目](../project-collaboration/1-project.md) |
| 成员 | 在成员列表中管理组织内的所有用户及其权限 |
| 设备 | 在组织设备列表中统一管理组织内所有设备。设备可以与真实设备建立联系,详见[设备](../../device/1-device.md) |
| 镜像 | 平台提供专业的私有镜像仓库,统一管理组织内所有镜像,详见[镜像](../../image/1-about-docker-image.md) |
| 用量与计费 | 展示组织的存储量、设备数、计算时长等信息 |

![org_1](./img/org_1.png)

## 创建组织

1. 通过浏览器访问[刻行时空平台 https://www.coscene.cn/](https://www.coscene.cn),点击右上角的【快速登录】,进入登录界面
![org_2](./img/org_2.png)

![org_2](./img/org_2.png)

2. 选择登录方式进入平台:邮箱、飞书、钉钉或谷歌企业邮箱

![org_3](./img/org_3.png)
![org_3](./img/org_3.png)

3. 填写「组织名称」与「组织 ID」,勾选「同意」,点击【创建组织】按钮
![org_4](./img/org_4.png)

![org_4](./img/org_4.png)

4. 创建成功后,自动进入组织首页

Expand All @@ -38,8 +41,11 @@ sidebar_position: 1
请参见[项目](../project-collaboration/1-project.md)章节

## 添加组织成员

通过不同方式创建的组织,添加成员的方式不同:

- **邮箱登录创建的组织**:

- 组织管理员在「组织管理-成员」页面,点击【邀请成员】按钮,通过邮箱邀请成员加入组织。

![org_5](./img/org_5.png)
Expand All @@ -55,12 +61,13 @@ sidebar_position: 1
请参见[添加设备](../../device/2-create-device.md)章节

## 添加镜像

> 组织中的镜像可以在各个项目中使用,用于[自动化](../../workflow/1-quick-start-workflow.md)或[批量测试](../../sim-and-tests/regression/1-intro.md)。

请参见[镜像](../../image/1-about-docker-image.md)章节


## 用量与计费

> 仅组织管理员可查看组织用量信息。

组织用量信息包括:组织的存储量、活跃设备数、计算时长等信息
Expand Down
34 changes: 24 additions & 10 deletions docs/collaboration/record/3-manage-records.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,17 @@ sidebar_position: 3
# 管理记录

记录支持以下操作:

- **基础操作**:查看、编辑、复制、移动、归档、删除
- **数据处理**:调用动作、标注
- **搜索统计**:搜索过滤、标签统计


## 基础操作

### 查看

在记录列表页,可查看记录的名称、缩略图、设备、标签、最近动作、自定义字段等信息。

- 点击记录名称,可进入记录详情页
- 点击缩略图,可放大查看
- 点击设备 ID,可进入项目设备的详情页
Expand All @@ -22,11 +25,12 @@ sidebar_position: 3
![record-list_1](./img/record-list_1.png)

### 编辑

在记录详情页,可编辑记录的相关信息,如名称、描述、设备、标签等。

1. 点击可直接编辑记录名称与描述。

![edit-record_1](./img/edit-record_1.png)
![edit-record_1](./img/edit-record_1.png)

2. 在记录基本信息栏,可选择设备与标签。

Expand All @@ -36,65 +40,74 @@ sidebar_position: 3
![edit-record_2](./img/edit-record_2.png)

### 复制与移动

将记录复制/移动到指定的项目中,实现数据的重新分类与整理。

1. 在记录详情中的更多操作中,选择【复制到】/【移动到】。

![create-record_7](./img/create-record_7.png)
![create-record_7](./img/create-record_7.png)

2. 在弹窗中选择要复制到/移动到的目标项目,点击【确定】按钮后,即可在目标项目中查看对应的记录。

![create-record_8](./img/create-record_8.png)
![create-record_8](./img/create-record_8.png)

### 归档

归档功能可将已完成分析的数据转为只读状态,并从活跃列表中移出,便于历史数据的长期管理。使用场景如下:

- 数据分析工作已完成,需要长期保存结果
- 阶段性实验数据需要归档保存
- 历史数据需要与活跃数据分开管理
- 需要保护重要数据避免误操作

1. 在记录详情中的更多操作中,选择【归档】。二次确认后,记录将被归档。

![manage-record_7](./img/manage-record_7.png)
![manage-record_7](./img/manage-record_7.png)

2. 在记录列表的归档栏,可查看归档的记录。
![manage-record_8](./img/manage-record_8.png)

![manage-record_8](./img/manage-record_8.png)

3. 在已归档记录的详情中,点击「更多」操作中的【解除归档】按钮,可将记录从归档状态转为活跃状态。

![manage-record_9](./img/manage-record_9.png)
![manage-record_9](./img/manage-record_9.png)

### 删除

> 删除后,记录将无法恢复。

在记录详情中的更多操作中,选择【删除】。二次确认后,记录将被删除。

![manage-record_10](./img/manage-record_10.png)

### 批量操作

在记录列表页,勾选需要操作的记录,可进行批量编辑标签、复制、移动、归档、删除等操作。

![manage-record_11](./img/manage-record_11.png)

## 数据处理

### 调用动作

在记录详情页,可调用动作对记录进行处理,如:裁剪数据、自动诊断、数据对比等。

1. 在记录详情页,点击【调用动作】按钮,选择需要对记录进行的操作。

![manage-record_2](./img/manage-record_2.png)
![manage-record_2](./img/manage-record_2.png)

2. 当动作执行完成后,即可在「调用历史」中查看处理结果。详见[自动化动作](../../workflow/1-quick-start-workflow.md)章节。

### 标注

> 仅配置了标注集成的项目可以使用。详情请咨询刻行时空。

在记录列表页,勾选需要标注的记录,点击【创建标注任务】按钮,即可在对应的标注平台生成标注任务。

![manage-record_3](./img/manage-record_3.png)

## 搜索统计

### 搜索和过滤

- **搜索**
Expand All @@ -110,6 +123,7 @@ sidebar_position: 3
![manage-record_6](./img/manage-record_6.png)

### 标签统计

点击记录列表中的【统计】按钮,查看每个标签下的记录数量:

![manage-record_4](./img/manage-record_4.png)
![manage-record_4](./img/manage-record_4.png)
6 changes: 3 additions & 3 deletions docs/developers/coSceneCli/1-cli-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ cocli update

:::tip

登录和初始化刻行 CLI 需要如下信息
登录和初始化刻行时空 CLI 需要如下信息

- 个人访问令牌(Token):
- 默认工作项目的(Slug):

:::

您可以在[刻行-我的设置](https://coscene.cn/profile?section=security)页面中生成访问令牌。
您可以在[刻行时空-我的设置](https://coscene.cn/profile?section=security)页面中生成访问令牌。

命令行工具同时需要指定一个默认项目作为所有操作的默认环境,请选择您想要工作的项目,并在 URL 中获取项目的 Slug。

Expand All @@ -53,7 +53,7 @@ cocli login set -p <项目 slug> -t <个人访问令牌>
```

:::info
如果您是刻行的企业用户,单独部署了刻行的实例,您需要在 login 的同时设置
如果您是刻行时空的企业用户,单独部署了刻行时空的实例,您需要在 login 的同时设置
您所在企业实例的 endpoint

例如 https://server2.coscene.cn -> https://openapi.server2.coscene.cn
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/coSceneCli/99-advanced-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 99

## 切换登录凭证

刻行的命令行工具内置了登录凭证管理系统,高级用户和测试人员可以在不同的组织、项目、和环境中切换登录凭证,方便测试和管理。
刻行时空的命令行工具内置了登录凭证管理系统,高级用户和测试人员可以在不同的组织、项目、和环境中切换登录凭证,方便测试和管理。

在您有了默认的登录凭证之后,想要再添加一个登录凭证时,您可以使用如下命令来添加一个新的登录凭证

Expand Down
4 changes: 2 additions & 2 deletions docs/developers/coSceneCli/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
"link": {
"type": "generated-index",
"slug": "/category/cocli",
"description": "使用刻行命令行工具进行数据管理。请注意 coCLI 工具正在积极开发和发布新版本。在这过程中可能会遇到一些 bug 或不稳定现象。我们会努力修复这些问题,感谢您的理解和支持。"
"description": "使用刻行时空命令行工具进行数据管理。请注意 coCLI 工具正在积极开发和发布新版本。在这过程中可能会遇到一些 bug 或不稳定现象。我们会努力修复这些问题,感谢您的理解和支持。"
}
}
}
6 changes: 3 additions & 3 deletions docs/developers/concepts/1-data-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ sidebar_position: 1

组织是一个逻辑概念,它代表了一个团队或者一个公司。组织可以拥有多个项目,也可以拥有多个成员。

在登录刻行时空平台时,如果你是所选择组织中第一个登录刻行平台的用户,你会成为该组织的管理员,并进行组织的初始化设置。
在登录刻行时空平台时,如果你是所选择组织中第一个登录刻行时空平台的用户,你会成为该组织的管理员,并进行组织的初始化设置。
如果你不是第一个登录的用户,你将会成为该组织的普通成员。

![org-first-user](img/org-first-user.png)

## 设备 Device

设备是指可以连接到刻行平台的任何物理设备,比如:智能终端、智能手表、智能手环、智能眼镜、智能车载设备、智能家居设备等。
设备是指可以连接到刻行时空平台的任何物理设备,比如:智能终端、智能手表、智能手环、智能眼镜、智能车载设备、智能家居设备等。

组织中的任何成员都可以在组织中添加设备。在组织中添加的设备会在所有的项目中可见。关于设备的详细操作,请参见[设备的操作指南](../../device/1-device.md)。

Expand All @@ -31,7 +31,7 @@ sidebar_position: 1

记录本身也会不停的迭代和丰富,用户和工作流可以不断的向记录内更新有用的信息。一个常见的例子就是原始数据可以被送往如百度和清华等标注供应商,进行特定框体,语义等的标注。这些标注信息在后续的机器学习、训练、和测试等流程中都会发挥巨大的作用。

在文件管理之上,刻行也对文件的版本和血缘进行了管理。你可能听过机器学习界的一句名言,garbage in garbage out,即垃圾输入垃圾输出。在刻行时空平台中,我们通过记录的版本和血缘管理,来保证数据的质量。在记录的版本中,我们可以看到记录的历史版本,以及每个版本的修改记录。在记录的血缘中,我们可以看到记录的上游和下游记录,以及每个记录的血缘关系。关于血缘和历史版本的详细信息,请参看关于记录对于[血缘和历史版本的说明](../../collaboration/record/3-manage-records.md)。
在文件管理之上,刻行时空也对文件的版本和血缘进行了管理。你可能听过机器学习界的一句名言,garbage in garbage out,即垃圾输入垃圾输出。在刻行时空平台中,我们通过记录的版本和血缘管理,来保证数据的质量。在记录的版本中,我们可以看到记录的历史版本,以及每个版本的修改记录。在记录的血缘中,我们可以看到记录的上游和下游记录,以及每个记录的血缘关系。关于血缘和历史版本的详细信息,请参看关于记录对于[血缘和历史版本的说明](../../collaboration/record/3-manage-records.md)。

## 支持的数据格式和平台处理能力

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/concepts/2-auth-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 2

数据是所有 coScene 用户最重要的资产,在让用户能高效利用数据的同时,我们也充分重视用户对于数据资产的安全和保密性的要求。从第一天开始,我们就在设计和构建一个灵活的、可扩展的、可配置的权限模型,以满足我们的客户的保密、安全和控制的需要。

coScene 目前的权限体系充分参考了行业内最佳实践,充分考虑了 [RBAC](https://en.wikipedia.org/wiki/Role-based_access_control) 和 [ABAC](https://en.wikipedia.org/wiki/Attribute-based_access_control) 模型对于我们应用的影响。在目前阶段,刻行的实现以 RBAC 作为基础,但会在接下来的发布中,逐渐引入 ABAC 的特性。最终达到一个灵活而又易懂的权限设置模型。
coScene 目前的权限体系充分参考了行业内最佳实践,充分考虑了 [RBAC](https://en.wikipedia.org/wiki/Role-based_access_control) 和 [ABAC](https://en.wikipedia.org/wiki/Attribute-based_access_control) 模型对于我们应用的影响。在目前阶段,刻行时空的实现以 RBAC 作为基础,但会在接下来的发布中,逐渐引入 ABAC 的特性。最终达到一个灵活而又易懂的权限设置模型。

## 组织和项目

Expand Down
Loading