added module:doc to abstract documentation

mlcommons · Apr 16, 2021 · 9938a0e · 9938a0e
1 parent 83a1fa4
commit 9938a0e
Show file tree

Hide file tree

Showing 9 changed files with 69 additions and 3 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,6 +1,7 @@
-* V1.55.4.1
+* V1.55.5
   * added --tags to "ck find" action to be able to search for entries 
     by tags and return their paths
+  * added module:doc to abstract documentation
 
 * V1.55.4
   * [sztaylor] fix cpu & gpu set_freq commands

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -10,7 +10,7 @@ Please see https://ck.readthedocs.io/en/latest/guide/how-to-contribute.html
 N: Grigori Fursin (alias: FGG)
 E: [email protected]
 H: https://fursin.net
-O: cTuning foundation, France
+O: cTuning foundation, France / OctoML.ai, USA
 C: original concept and prototyping, real-world use cases, development of https://cKnowledge.org and https://cKnowledge.io
 W: since Nov.1, 2014 
 

diff --git a/ck/kernel.py b/ck/kernel.py
@@ -27,7 +27,7 @@
 
 
 # We use 3 digits for the main (released) version and 4th digit for development revision
-__version__ = "1.55.4.1"
+__version__ = "1.55.5"
 # Do not use characters (to detect outdated version)!
 
 # Import packages that are global for the whole kernel

diff --git a/ck/repo/module/.cm/alias-a-doc b/ck/repo/module/.cm/alias-a-doc
@@ -0,0 +1 @@
+52b840ae194e640b
diff --git a/ck/repo/module/.cm/alias-u-52b840ae194e640b b/ck/repo/module/.cm/alias-u-52b840ae194e640b
@@ -0,0 +1 @@
+doc
diff --git a/ck/repo/module/doc/.cm/desc.json b/ck/repo/module/doc/.cm/desc.json
@@ -0,0 +1 @@
+{}
diff --git a/ck/repo/module/doc/.cm/info.json b/ck/repo/module/doc/.cm/info.json
@@ -0,0 +1,21 @@
+{
+  "backup_data_uid": "52b840ae194e640b",
+  "backup_module_uid": "032630d041b4fd8a",
+  "backup_module_uoa": "module",
+  "control": {
+    "author": "Grigori Fursin",
+    "author_email": "[email protected]",
+    "author_webpage": "http://fursin.net",
+    "copyright": "See CK COPYRIGHT.txt for copyright details",
+    "engine": "CK",
+    "iso_datetime": "2021-04-16T15:54:03.688043",
+    "license": "See CK LICENSE.txt for licensing details",
+    "version": [
+      "1",
+      "55",
+      "4",
+      "1"
+    ]
+  },
+  "data_name": "doc"
+}
diff --git a/ck/repo/module/doc/.cm/meta.json b/ck/repo/module/doc/.cm/meta.json
@@ -0,0 +1,9 @@
+{
+  "actions": {},
+  "copyright": "See CK COPYRIGHT.txt for copyright details",
+  "desc": "documentation",
+  "developer": "Grigori Fursin",
+  "developer_email": "[email protected]",
+  "developer_webpage": "http://fursin.net",
+  "license": "See CK LICENSE.txt for licensing details"
+}
diff --git a/ck/repo/module/doc/module.py b/ck/repo/module/doc/module.py
@@ -0,0 +1,32 @@
+#
+# Collective Knowledge (documentation)
+#
+# See CK LICENSE.txt for licensing details
+# See CK COPYRIGHT.txt for copyright details
+#
+# Developer: Grigori Fursin, [email protected], http://fursin.net
+#
+
+cfg = {}  # Will be updated by CK (meta description of this module)
+work = {}  # Will be updated by CK (temporal data)
+ck = None  # Will be updated by CK (initialized CK kernel)
+
+# Local settings
+
+##############################################################################
+# Initialize module
+
+
+def init(i):
+    """
+
+    Input:  {}
+
+    Output: {
+              return       - return code =  0, if successful
+                                         >  0, if error
+              (error)      - error text if return > 0
+            }
+
+    """
+    return {'return': 0}