3 user_guide
tanglj edited this page 2 years ago

OpenI启智社区用户使用手册

一、基本操作说明

1.1 安装与启动

  • 系统采用B/S架构,用户使用之前需要安装任意浏览器(推荐google浏览器),并通过该网址OpenIhttps://git.openi.org.cn/)访问此平台。

1.2 登陆与注册

1.2.1 未登录状态权限说明

  • 未登陆用户可以进行启智社区、探索等操作。在探索模式下只具有查看所有项目、数据集的权限。
  • 如果用户需要在社区内构建属于自己的项目,需要进行登陆操作。
  • 对于未在平台上注册过的用户,需要进行注册才能进行系统登陆。

1.2.2 注册

avatar

  • 注册规则
    • 用户名需要是字母,数字,下划线,破折号一种方式或多种组合方式组成
    • 一个邮箱与一个用户名一一对应。
    • 密码长度至少6位,并且至少包含一个小写字母和1个数字。
  • 在完成信息填写后,点击【注册账号】按钮,即可完成注册。

1.2.3 登录

  • 分类:

    • 登陆功能根据用户类型不同,包括普通社区用户登陆云脑用户登陆两种类型。其中云脑用户登陆只有内网才能访问,并且是申请制的。
  • 普通社区用户登陆的页面,用户可以根据注册时填写的用户名或者邮箱和密码进行OpenI社区平台的登陆操作。

    avatar

  • 云脑用户登陆的页面,用户可以根据云脑用户名和密码进行OpenI社区平台的登陆操作。

avatar

1.3 用户个人功能设置

1.3.1 功能概览

  • 用户登陆成功后,鼠标左键单击头像下拉框,系统显示个人中心、个人信息、已点赞、设置、退出、通知等选项。

avatar

1.3.2 个人中心

  • 点击【个人中心】,页面左侧区域显示的是用户一年内对平台的总贡献,右侧显示的是用户创建的项目列表,用户可以根据项目关键字进行项目检索。

avatar

1.3.3 组织

1.3.1 创建组织
  • 点击【组织】,在我的组织里点击右侧【+】,可以添加组织。该功能有利于团队协作,方便项目负责人对人员进行组织

    avatar

  • 用户输入组织名称,根据需要选择可见性和权限,点击【创建组织】按钮,即可完成组织添加。点击【取消】按钮,系统将不对其进行修改,并离开此页面。

avatar

1.3.4 个人信息

  • 点击【个人信息】,页面显示在该用户下的项目列表,数据集,关注和点赞等信息。
  • 用户根据需要可以通过点击排序进行按创建时间、按名称、按派生、按更新频率等方式排序。

avatar

1.3.5 设置

  • 点击【设置】,进入到用户信息设置界面。在此界面,用户可以根据需要,对个人信息、账号、安全、应用、SSH/GPG密钥、组织、项目列表等相关信息进行查看与更改。

avatar

1.3.6 退出

  • 点击【退出】按钮,用户状态由登陆状态切换为游客状态。同时,用户拥有的访问权限也切换为游客状态

1.3.7 通知

  • 为了更加方便及时的接收消息,我们在界面右上角部分增加了通知功能,在用户登陆成功以后,通知图标将存在于所有页面内。

avatar

1.4 创建项目

  • 该平台为用户代码托管提供了平台支撑,项目的创建包括两种方式。
    • 方式一:进入【个人中心】创建项目,点击【个人中心】按钮,点击项目列表右侧的【+】号进行项目的创建。

avatar

  • 方式二:直接点击导航栏中的【+】号,选择【创建项目】选项,进行项目创建:

avatar

  • 依据方式一/方式二的操作,系统将自动跳转到项目信息填写界面。
    • 项目拥有者和项目名称为必填项,其他相关信息依据用户需要进行相应填写
    • 项目信息填写完毕后,点击【创建项目】按钮完成项目的创建。
    • 项目创建完成之后,系统自动跳转到项目创建完成后的界面

avatar

avatar

1.4.3 windows安装git

1.4.3.1 下载git

下载地址:http://git-scm.com/download/win 选择对应的版本,windows系统一般为64位系统,可以根据自己电脑的配置进行选择。

downloadgit

1.4.3.2 安装

双击安装git,选择默认就可以了,一路点击next

install1

install2

选择install。

install3

install4

安装完毕!

1.4.3.3 生成密钥和公钥

右击桌面,选择git bush here

bushhere

然后出现DOS窗口

doc

输入:git config --global user.name "输入你的用户名"(这个用户名是你在启智开源平台注册的邮箱)

doc2

点击enter

doc3

输入:ssh-keygen -t rsa -C "邮箱账号",不用设置密码,连续点击三次enter;

doc4

你会在你的C:\Users{个人电脑名称} .ssh目录下找到如下文件:

pub1

id_rsa.pub文件中则保存了生成的ssh秘钥信息,可用记事本打开查看。

pub2

CTRL+A全部复制。

1.4.3.6 配置公钥

登录启智平台

opnlpub1

点击个人头像,点击设置

opennlpub2

点击SSH/GPG密钥

opennlpub3

这里会显示你之前添加过的公钥,

opennlpub4但是每一次自己的电脑生成公钥,都要重新添加,之前都旧的可以删除;

点击添加密钥

opnlpub5

将文件pub中的密钥复制粘贴到这里,名字可以任意命名,但是不能和历史添加的密钥名称相同。

opennlpub6

点击添加密钥,添加成功。

opennlpub7

1.4.2 项目克隆与推送

  • 在项目创建完毕之后,用户可以使用该页面内的命令,实现工作区与远程仓库项目之间的克隆与推送。
1.4.2.1 克隆
  • 方式一:基于HTTP方式的克隆

    • 使用命令 git clone [URL],其中,URL为图中相应位置对应的地址。通过此方式即可实现将项目克隆到工作区。

      注意:URL会根据您的项目自动生成,所以不同项目对应的URL会存在差异。

avatar

  • 方式二:基于SSH方式的克隆
    • 首先,我们需要配置SSH密钥,点击导航栏中【我的头像】,选择【设置】进入到【SSH/GPG密钥】

project_initavatar

  • 点击管理ssh密钥中右侧的【添加密钥】,将相应的密钥复制到管理ssh密钥该条目下的文本框中即可使用。为了增强用户使用体验,我们针对需要帮助的用户提供了“如何生成SSH密钥”和“常见SSH问题”使用手册。
  • 密钥添加完毕后返回项目下,使用命令git clone [URL],其中URL为图3-18相应标注位置中的地址。

avatar

1.4.2.2 推送
  • 方式一:基于HTTP方式推送

avatar

  • 方式二:基于SSH方式推送

avatar

1.4.3 代码管理

1.4.3.1 代码架构一览
  • 该平台在只创建项目未在该项目下上传工作文件的时候,项目只显示代码、任务集、任务、百科、云脑。

avatar

  • 当在该项目中推送工作文件后,导航栏如图标注2-标注4所示,增加了合并请求、版本发布和动态三个子模块。

avatar

1.4.3.2 代码上传与下载
  • 点击标注1区域进行上传文件,进入上传页面。
  • 使用终端下载项目请点击标注2区域进行复制,
  • 直接下载到本地点击标注3区域进行下载文件。

avatar

  • 用户可在区域1选择上传的目录,将文件拖入标注区域2,在标注3区域选择提交分支,点击标注4处的按钮,完成文件上传。

avatar

1.4.3.3 合并代码
  • 用户可以将不同分支的项目进行合并
  • 点击标注1区域,选择合并到的分支,点击标注2区域,选择项目拉取分支。标注区4显示的是即将被合并的文件列表。点击标注3开启创建合并请求。

avatar

  • 点击标注区域中【合并请求】,进行查看合并请求历史记录。

avatar

1.4.3.4 版本发布
  • 标注1区域内填写已有或者新建标签
  • 标注2区域内填写版本发布的标题信息,此处为必填项
  • 在标注3选择是否为预发行版,发布相应版本文件。
  • 用户可以根据需要点击标注5进行保存或者直接点击发布版本进行发布。

avatar

1.4.3.5 动态
  • 在本界面中,标注1选择动态查看的时间范围,相应的项目动态信息将显示到标注2区域。

avatar

1.5 数据集存储

1.5.1 功能描述

  • 用户创建完相关项目之后,可以在项目下上传数据集。该数据集主要是为您的项目服务的,当您准备在云脑平台上运行项目时,数据集来源于这里
  • 数据集上传格式***.zip格式**的文件
  • 为了方便用户查看管理数据集,我们在页面右侧增加了数据集分类、研究方向/应用领域、license等标签供用户选择。用户选择标签能够提高您的项目的标识度,提高检索率,强烈建议您完善该部分
  • 云脑1和云脑2 数据集不共用,请您根据您的需求进行选择上传路径,两个计算平台都支持断点续传功能。
  • 在本页面内,用户可以实现对增添数据集、更改数据集名称及添加数据集描述等信息。点击【编辑】按钮,系统进入更新数据集信息界面,点击【更新数据集】按钮实现数据集信息的更新。

avatar

avatar

1.5.2 上传方式

  • 方式一:拖拽文件

    avatar

  • 方式二:点击上传,点击后弹出界面,选择相应文件进行上传。

avatar

1.5.3 权限

  • 用户有权决定数据集保持公有或私有状态。此外,根据用户下载量,实时显示数据集下载量。
  • 用户可以对数据集进行删除,数据集一旦删除无法进行恢复,请慎重删除数据集

avatar

二、云脑

2.1 概况

启智社区与智能算力云脑平台对接,旨在为用户提供一体化服务,该服务集环境搭建、项目在线调试、运行、结果分析与评估于一体。其中,云脑1旨在为用户提供GPU资源, 云脑2旨在为用户提供NPU资源

2.2 前置工作

  • 用户需要在登录状态下才能操作云脑,请确保您已登录系统。
  • 如果您尚未在本平台创建任何项目,请先完成创建项目
  • 如果您存在多个项目,请先进入您想操作的项目。

2.3 云脑1

2.3.1 新建任务

  • 点击导航栏中的【云脑】,选择【云脑1】进入云脑界面。

    avatar

  • 点击【新建任务】界面,创建完成后即可使用云脑资源。

    avatar

  • 点击【标注1】,选择镜像,此镜像是您准备使用的运行环境。点击【标注2】,选择您项目中使用的数据集。之后点击【新建任务】即可完成创建云脑1任务。

    avatar

    注意:

    ​ 1、如果您期望使用的数据集未在上述数据集下拉列表中,请先在数据集处上传您需要的数据集

    ​ 2、只有任务状态为RUNNING状态,才能开始调试,如果创建完任务后,显示为WAITTING状态,您可以进行手动刷新。

2.3.2 任务调试

  • 点击【调试】即可进入调试界面,其功能如下

    avatar

    注意: 由于在创建云脑任务的时候,代码路径固定设置的为/code,因此,在终端进行进行项目查看时,请先切换至/code路径下。

2.3.2.1 左侧功能区
  • 标注1表示在标注5路径下新增文件,标注2标注在标注5路径下新增文件夹,标注3表示在将文件上传至标注5所处路径下。请注意,**上传文件命名不能包含汉字。**点击标注4,对项目列表进行更新。标注6区域显示用户代码项目的名称和更改日期。

    avatar

2.3.2.2 右侧功能区
  • python代码编辑有两种形式:
    • 标注1 NOTEBOOK方式**,
    • 标注2 命令行形式
  • 除了可以编辑python代码外,用户还可以在标注3处打开终端,在标注4处编写文本文档,在标注5处编写markdown文档,标注6处打开功能使用向导

avatar

2.3.2.4 调试代码状态查看
  • 点击标注1区域,可以在标注2处查看代码文件的状态

    • KERNEL SESSIONS显示的是标注3和标注4区域打开的窗口。

    • TERMINEL SESSIONS显示的是标注5区域打开的窗口。

      注意:如果要关闭相应窗口,点击KERNEL SESSIONS或TERMINEL SESSIONS列表中所对应的名称所对应的SHUT DOWN字样即可关闭。

avatar

2.3.2.5 自定义配置点击
  • 点击标注1处,在标注2处选择想要更改标注3中的子选项,对其设置信息进行变更操作。

avatar

2.3.3 提交镜像

  • 为了方便用户您下次创建任务时使用该环境配置,您可以将本次配置的环境信息进行保存。

  • 点击【提交镜像】,完成相关信息输入,即可保存。

    avatar

注意:您需要在RUNNING状态下才能提交镜像

  • 提交镜像之后,用户在下次【新建任务】的时候,可以在图标注1处选择之前提交过的镜像。

avatar

2.4 云脑2

三、任务

3.1 功能描述

  • 为了方便用户团队协作开发,我们在平台中设置了任务模块,用于将项目中的任务指配给相应成员,并设立项目里程碑记录项目关键节点。此外,还为任务设置标签以区分任务类型

3.2 创建任务

  • 点击页面中的【新建任务】开启任务创建。
  • 为了方便用户在发布任务之前对任务审核,我们设置【预览】模块。点击【预览】,即可显示相关文字及文件部分。
  • 点击【创建文档】按钮,完成任务创建。

注意:由于标题可以方便用户高效检索以及查阅,所以我们设置任务【标题】不可缺失,请您注意填写。

avatar

3.3 任务修改、评论、引用

  • 点击标注区,显示相应的表情,其他用户可以对该项目进行评价。

avatar

  • 点击标注区中的【…】,系统会自动添加引用文本,效果如图文本编辑区所示。

avatar

3.4 任务标签

3.4.1 创建

  • 为了更好的区分任务类型,可以点击图中标注的【创建标签】对任务添加标签。系统默认有七种标签

avatar

  • 标注区域输入标签名、描述、选择标签颜色后,点击【创建标签】按钮,即可增加新标签。

avatar

3.4.2 修改、删除

  • 点击【编辑】,针对现有标签页可以进行更改名称、描述及标签颜色的自由更改。点击【删除】,可以删除该标签。

avatar

3.5 里程碑

3.5.1 创建、编辑里程碑

  • 切换到项目任务界面创建里程碑,点击【新建里程碑】,系统页面跳转到里程碑内容填写界面填写标题、描述、设置截止日期,其中描述和截止日期为可选项,点击【创建里程碑】完成创建。

avatar

  • 创建完里程碑后,用户可以针对里程碑进行编辑、关闭、删除等操作。

avatar

3.5.2 关闭与开启里程碑

  • 点击关闭操作,系统将里程碑标记为关闭状态,用户可以通过点击图3-49中标记的区域,实现里程碑的再开启。

avatar

3.5.3 快速查看里程碑

  • 点击标注区,即可快速开启查看与自己有关的里程碑相关信息。

avatar

3.6 任务管理

  • 点击标注1,即可进入任务管理界面
  • 在标注2区域,用户可以根据类型查看与自己相关的任务
  • 在标注3区域,用户可以根据项目进行查看看与自己相关的任务
  • 标注区4为任务显示区域,可以查看已开启状态和已关闭状态的任务。

avatar

四、 项目相关信息配置

4.1 项目基础和高级设置

  • 标注1显示了项目配置入口

avatar

  • 在项目配置中,用户可以根据需要更改项目的基本设置和高级设置。用户更改基本设置之后。

注意:请您慎重操作【危险操作区】,此处一经操作,无法恢复。

avatar

4.2 项目添加与删除协作者

  • 进入项目,点击【项目设置】,点击标注2处的【协作者】进入协作者编辑页面,点击标注3区域,搜索协作者的用户名,点击标注4【添加协作者】确认添加该用户到此项目的协作者中。此外,项目拥有者可以点击标注5处的【删除】按钮,将用户移出协作者中。

avatar

4.3 项目管理web钩子

  • 点击导航栏中的【管理web钩子】,点击标注1中的【添加web钩子】选择需要的选项即可进入钩子添加页面,用户可以点击标注2以获得更多的内容。

avatar

  • 标注1处输入URL地址,在标注2处下拉框中选择HTTP方法和内容类型,标注3处的密钥文本为选填部分,用户填写好相关信息点击【添加web钩子】即可创建成功。

avatar

4.4 管理部署密钥

  • 点击【添加部署密钥】设置项目的只读拉取权限。点击后,在标注1处填写标题。请注意,此处为必填项。在标注2处填写您的密钥,标注3处设置是否具有写权限,默认是无。最后,点击标注4处的添加部署密钥完成添加操作。

avatar

4.5 管理LFS文件

  • LFS文件主要提供大文件支持LFS它将标记的大文件保存至另外的仓库,在主仓库仅保留其轻量级指针。在检出版本时,根据指针的变化情况下更新对应的大文件.而不是在本地保存所有版本的大文件。点击标注1处,即可查找指针文件以及锁定LFS文件。

avatar

五、启智社区生态

5.1 加入启智社区

  • 方式一:点击标识区域进入启智社区平台入口

avatar

  • 方式二:通过该网址(https://openi.org.cn/)直接进行启智社区访问,进入【加入启智社区】入口。

avatar

5.2 查看社区组织架构及规章制度

查看相应文件有两种方式。

方式一:点击下图所示区域内选项进行查看

rolemethod1

方式二:点击下图所示区域内选项进行查看

rolemethod2

5.3 启智社区项目

点击下图所示标注1区域,进入启智社区项目,标注2为显示当前启智社区项目的全景图。用户可以通过点击项目进入项目详情页。

viewqzitem

启智项目详情页主要由图3-96所示区域中标识的几大部分组成,其中,

【总览】为项目的简介,带您快速了解项目。

【代码】为项目源代码,查看项目代码有两种方式。

【文档】和【教程】区主要为该项目相关文档和使用方法。

【活动】和【竞赛】区主要为该项目近期或以往所组织的活动和竞赛。

为了方便用户进行问题反馈与交流,可以在交流区提供的网址发送信息。动态为该项目所有动态信息。

viewdetailitem

方式一进入启智项目代码

entercode1

方式二进入启智项目代码

entercode2

5.4 启智社区学习

为了方便学习,我们设置了人工智能相关的学习资料,在下图标注区为进入学习的入口。

qzsqlearning1

5.5 查看启智社区活动

点击下图中标注区域进入启智社区活动界面,用户可以根据标注区域中按类别进行活动筛选。

qzsqhuodong

6 探索

6.1探索所有项目

本平台可以通过点击下图中标注1的位置进行查看他人项目,用户可以根据标注2中的项目、数据集、组织分类进行查看。

searchalllitem

用户找到合适的项目后,单击下图标注处即可进入项目进行查阅。

vireallitem

6.2探索数据集

点击下图界面内的标注区域,即可直接访问该平台中所有公有的数据集。

searchdataset

6.3探索启智项目

启智项目采用会员申请制,用户如果想将项目申请加入到启智项目中,首先点击下图中的标注1区域,进入到所有项目中,点击区域2完成申请项目到OpenI

seatchqzitem