@@ -47,27 +46,70 @@
📫 Feedback on usage issues: contact.viesc@gmail.com / Professional consulting for server equipment: tensor.station@gmail.com
@@ -47,27 +46,70 @@
📫 Feedback on usage issues: contact.viesc@gmail.com / Professional consulting for server equipment: tensor.station@gmail.com
+ 
+
+ 
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
diff --git a/README_zh-CN.md b/README_zh-CN.md
index d7f7f2367a..c59b0ecb2e 100755
--- a/README_zh-CN.md
+++ b/README_zh-CN.md
@@ -31,39 +31,78 @@
-
+
📫 使用问题反馈：contact.viesc@gmail.com / 服务器级设备专业咨询：tensor.station@gmail.com
-
+
+
+ 
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
diff --git a/dev_docs/import-extra-models.md b/dev_docs/import-extra-models.md
new file mode 100644
index 0000000000..f0e20b1b6f
--- /dev/null
+++ b/dev_docs/import-extra-models.md
@@ -0,0 +1,71 @@
+# 如何导入外部模型
+
+## 外部模型的准备
+
+假设有一个在 ymir 系统外部进行的基于 mxnet 的训练过程，这个训练过程在第 1000 个 epoch 的时候产生了模型 `model-1000.params` 和 `model-symbol.json`，其 mAP 是 0.3，在第 2000 个 epoch 的时候产生了模型 `model-2000.params` 和 `model-symbol.json`，其 mAP 是 0.6，现在想要将这个过程中产生的模型导入 ymir 系统中。
+
+在导入外部模型之前，需要做如下准备：
+
+1. 将训练过程中产生的文件，如 `model-1000.params`, `model-2000.params`, `model-symbol.json`，拷贝到同一路径下；
+
+2. 在此路径下生成 `ymir-info.yaml` 文件，其格式如下：
+
+``` yaml
+executor_config:
+ class_names: # 训练目标，必要
+ - person
+ - cat
+stages: # 训练过程中产生的 model stages，必要
+ stage_1000: # 在 epoch 1000 时产生的 model stage name，必要
+ files: # 此 model stage 对应的文件，必要
+ - model-1000.params
+ - model-symbol.json
+ mAP: 0.3 # 此 model stage 的 mAP，必要
+ stage_name: stage_1000 # model stage name，必要
+ timestamp: 1655975204 # model stage 的创建时间，用 `ls --time-style=+%s -l` 取得文件创建时间，必要
+ stage_2000:
+ files:
+ - model-2000.params
+ - model-symbol.json
+ mAP: 0.6
+ stage_name: stage_2000
+ timestamp: 1655975205
+best_stage_name: stage_2000 # 最好的 model stage name，必要
+task_context:
+ executor: sample-executor # 训练模型时所用的镜像，非必要
+ mAP: 0.6 # 最好的 model stage 对应的 mAP
+ producer: fenrir-z # 模型作者
+ task_parameters: '{"keywords": ["person", "cat"]}' # keywords 与 class_names 一致, 注意引号
+```
+
+3. 将 `ymir-info.yaml` 和所有模型文件打包：
+
+``` bash
+tar -czvf model.tar.gz model-1000.params model-2000.params model-symbol.json ymir-info.yaml
+```
+
+## 如何导入
+
+可以使用 ymir 的模型导入功能，也可以使用以下命令行：
+
+``` bash
+mir models --package-path /path/to/model.tar.gz
+ --root /path/to/mir/repo
+ --dst-rev model-0@model-0 # xxx@xxx 格式，导入模型即意味着产生一个新的模型分支
+ --model-location /path/to/ymir-models # ymir 系统模型保存路径
+ -w /path/to/tmp/work/dir # 模型导入时的临时工作目录
+```
+
+如果导入成功，控制台会显示以下信息：
+
+``` plain
+pack success, model hash: xxxxxxxxxxxxxxxx, best_stage_name: stage_2000, mAP: 0.6
+```
+
+这里产生的 model hash 就是此模型在 ymir 中的 id，当使用命令行进行挖掘，推理时，可以提供此 model hash 和 model stage 给相应的命令。
+
+## 限制与注意事项
+
+1. 在 `外部模型的准备` 一节中的第 2 步中标明 `必要` 的字段都需要提供
+
+2. 模型的继续训练，推理，挖掘等任务需要配合特定镜像完成，所以需要在导入模型时，明确其使用的镜像，使其在后续流程中可用
diff --git a/docs/ymir-cmd-container.md b/dev_docs/ymir-cmd-container.md
similarity index 83%
rename from docs/ymir-cmd-container.md
rename to dev_docs/ymir-cmd-container.md
index 44aa51fa17..8899c56262 100644
--- a/docs/ymir-cmd-container.md
+++ b/dev_docs/ymir-cmd-container.md
@@ -1,5 +1,11 @@
# ymir 与功能性 docker container 数据传输接口
+| 协议文档版本 | ymir 版本 | 说明 | 镜像适配方式 |
+| --- | --- | --- | --- |
+| [0.0.0](https://raw.githubusercontent.com/IndustryEssentials/ymir/release-1.1.0/docs/ymir-cmd-container.md) | 0.0.0 - 1.1.0 | 初始版本 | |
+| [1.0.0](https://raw.githubusercontent.com/IndustryEssentials/ymir/ymir-pa/docs/ymir-cmd-container.md) | 1.2.0 - 1.2.2 | 增加关于中间模型的描述 | 使用 `write_model_stage` 方法保存训练产出的中间模型 |
+| 1.1.0 | 2.0.0 - | 4.3.2 节，训练完成后，模型保存策略更改'+(n?e:nn(e,!0))+"\n":""+(n?e:nn(e,!0))+"\n"+e+"\n"},e.prototype.html=function(e){return e},e.prototype.heading=function(e,t,n,r){return this.options.headerIds?"
"+e+"
\n"},e.prototype.table=function(e,t){return""+e+""},e.prototype.br=function(){return this.options.xhtml?""+hn(e.message+"",!0)+"";throw e}}fn.options=fn.setOptions=function(e){return un(fn.defaults,e),dn(fn.defaults),fn},fn.getDefaults=Lt,fn.defaults=mt,fn.use=function(o){var t,e=un({},o);if(o.renderer){var n,a=fn.defaults.renderer||new rn;for(n in o.renderer)!function(r){var i=a[r];a[r]=function(){for(var e=[],t=arguments.length;t--;)e[t]=arguments[t];var n=o.renderer[r].apply(a,e);return!1===n&&(n=i.apply(a,e)),n}}(n);e.renderer=a}if(o.tokenizer){var i,s=fn.defaults.tokenizer||new Gt;for(i in o.tokenizer)!function(){var r=s[i];s[i]=function(){for(var e=[],t=arguments.length;t--;)e[t]=arguments[t];var n=o.tokenizer[i].apply(s,e);return!1===n&&(n=r.apply(s,e)),n}}();e.tokenizer=s}o.walkTokens&&(t=fn.defaults.walkTokens,e.walkTokens=function(e){o.walkTokens(e),t&&t(e)}),fn.setOptions(e)},fn.walkTokens=function(e,t){for(var n=0,r=e;n
"+hn(e.message+"",!0)+"";throw e}},fn.Parser=cn,fn.parser=cn.parse,fn.Renderer=rn,fn.TextRenderer=on,fn.Lexer=Jt,fn.lexer=Jt.lex,fn.Tokenizer=Gt,fn.Slugger=an;var gn=fn.parse=fn;function mn(e,n){if(void 0===n&&(n=''),!e||!e.length)return"";var r="";return e.forEach(function(e){var t=e.title.replace(/(<([^>]+)>)/g,"");r+='
'+t.slice(5).trim()+"
"}function yn(e,r){var i=[],o={};return e.forEach(function(e){var t=e.level||1,n=t-1;r
'}function Sn(e){void 0===e&&(e="");var r={};return{str:e=e&&e.replace(/^('|")/,"").replace(/('|")$/,"").replace(/(?:^|\s):([\w-]+:?)=?([\w-%]+)?/g,function(e,t,n){return-1===t.indexOf(":")?(r[t]=n&&n.replace(/"/g,"")||!0,""):e}).trim(),config:r}}function An(e){return void 0===e&&(e=""),e.replace(/(<\/?a.*?>)/gi,"")}xn.clear=function(){bn={}};var Tn,En=ft(function(e){var a,s,l,c,u,r,t,i=function(l){var c=/\blang(?:uage)?-([\w-]+)\b/i,t=0,$={manual:l.Prism&&l.Prism.manual,disableWorkerMessageHandler:l.Prism&&l.Prism.disableWorkerMessageHandler,util:{encode:function e(t){return t instanceof F?new F(t.type,e(t.content),t.alias):Array.isArray(t)?t.map(e):t.replace(/&/g,"&").replace(/=a.reach);y+=v.value.length,v=v.next){var b=v.value;if(n.length>t.length)return;if(!(b instanceof F)){var k,w=1;if(f){if(!(k=C(m,y,t,d)))break;var x=k.index,_=k.index+k[0].length,S=y;for(S+=v.value.length;S<=x;)v=v.next,S+=v.value.length;if(S-=v.value.length,y=S,v.value instanceof F)continue;for(var A=v;A!==n.tail&&(S<_||"string"==typeof A.value);A=A.next)w++,S+=A.value.length;w--,b=t.slice(y,S),k.index-=y}else if(!(k=C(m,0,b,d)))continue;var x=k.index,T=k[0],E=b.slice(0,x),R=b.slice(x+T.length),O=y+b.length;a&&O>a.reach&&(a.reach=O);var b=v.prev;E&&(b=L(n,b,E),y+=E.length),z(n,b,w);var T=new F(s,h?$.tokenize(T,h):T,g,T);v=L(n,b,T),R&&L(n,v,R),1'+En.highlight(e.replace(/@DOCSIFY_QM@/g,"`"),n,t)+""+e+"
";return e},i.image=(r=(n={renderer:e,contentBase:r,router:o}).renderer,u=n.contentBase,p=n.router,r.image=function(e,t,n){var r=e,i=[],o=Sn(t),a=o.str,o=o.config;return t=a,o["no-zoom"]&&i.push("data-no-zoom"),t&&i.push('title="'+t+'"'),o.size&&(t=(a=o.size.split("x"))[0],(a=a[1])?i.push('width="'+t+'" height="'+a+'"'):i.push('width="'+t+'"')),o.class&&i.push('class="'+o.class+'"'),o.id&&i.push('id="'+o.id+'"'),O(e)||(r=N(u,F(p.getCurrentPath()),e)),0
+ {label}: {keywords.map(keyword =>
{t('project.iteration.entrance.empty.info')}
+ +