Merge pull request #43 from machine-intelligence-laboratory/version_0.7.0_prerelease

Version 0.7.0 prerelease

Author: Evgeny-Egorov-Projects

docs/cooking_machine/config_parser.html

@@ -142,10 +142,6 @@ <h1 class="title">Module <code>topicnet.cooking_machine.config_parser</code></h1
     &#34;theta_name&#34;: Str()
 }
 
-# change log style
-lc = artm.messages.ConfigureLoggingArgs()
-lc.minloglevel = 3
-lib = artm.wrapper.LibArtm(logging_config=lc)
 
 element = Any()
 base_schema = Map({
@@ -522,12 +518,12 @@ <h1 class="title">Module <code>topicnet.cooking_machine.config_parser</code></h1
         return modalities_to_use
 
 
-def parse(yaml_string, force_single_thread=False):
+def parse(yaml_string, force_separate_thread=False):
     &#34;&#34;&#34;
     Parameters
     ----------
     yaml_string : str
-    force_single_thread : bool
+    force_separate_thread : bool
 
     Returns
     -------
@@ -572,7 +568,7 @@ <h1 class="title">Module <code>topicnet.cooking_machine.config_parser</code></h1
     for stage in parsed[&#39;stages&#39;]:
         for elemtype, elem_args in stage.items():
             settings = build_cube_settings(elemtype.data, elem_args)
-            if force_single_thread:
+            if force_separate_thread:
                 settings[elemtype][&#34;separate_thread&#34;] = False
             cube_settings.append(settings)
 
@@ -610,8 +606,33 @@ <h1 class="title">Module <code>topicnet.cooking_machine.config_parser</code></h1
 
 
 def build_experiment_environment_from_yaml_config(yaml_string, experiment_id,
-                                                  save_path, force_single_thread=False):
-    settings, regs, model, dataset = parse(yaml_string, force_single_thread)
+                                                  save_path, force_separate_thread=False):
+    &#34;&#34;&#34;
+    Wraps up parameter extraction and class instances creation
+    from yaml formatted string
+    together with the method that builds experiment pipeline from
+    given experiment parameters (model, cubes, regularizers, etc)
+
+    Parameters
+    ----------
+    yaml_string: str
+        config that contains the whole experiment pipeline description
+        with its parameters
+    save_path: str
+        path to the folder to save experiment logs and models
+    experiment_id: str
+        name of the experiment folder
+    force_separate_thread: bool default = False
+        experimental feature that packs model training into
+        separate process which is killed upon training completion
+        by default is not used
+
+    Returns
+    -------
+
+    tuple experiment, dataset instances of corresponding classes from topicnet
+    &#34;&#34;&#34;
+    settings, regs, model, dataset = parse(yaml_string, force_separate_thread)
     # TODO: handle dynamic addition of regularizers
     experiment = Experiment(experiment_id=experiment_id, save_path=save_path, topic_model=model)
     experiment.build(settings)
@@ -671,17 +692,64 @@ <h2 id="returns">Returns</h2>
 </details>
 </dd>
 <dt id="topicnet.cooking_machine.config_parser.build_experiment_environment_from_yaml_config"><code class="name flex">
-<span>def <span class="ident">build_experiment_environment_from_yaml_config</span></span>(<span>yaml_string, experiment_id, save_path, force_single_thread=False)</span>
+<span>def <span class="ident">build_experiment_environment_from_yaml_config</span></span>(<span>yaml_string, experiment_id, save_path, force_separate_thread=False)</span>
 </code></dt>
 <dd>
-<section class="desc"></section>
+<section class="desc"><p>Wraps up parameter extraction and class instances creation
+from yaml formatted string
+together with the method that builds experiment pipeline from
+given experiment parameters (model, cubes, regularizers, etc)</p>
+<h2 id="parameters">Parameters</h2>
+<dl>
+<dt><strong><code>yaml_string</code></strong> :&ensp;<code>str</code></dt>
+<dd>config that contains the whole experiment pipeline description
+with its parameters</dd>
+<dt><strong><code>save_path</code></strong> :&ensp;<code>str</code></dt>
+<dd>path to the folder to save experiment logs and models</dd>
+<dt><strong><code>experiment_id</code></strong> :&ensp;<code>str</code></dt>
+<dd>name of the experiment folder</dd>
+<dt><strong><code>force_separate_thread</code></strong> :&ensp;<code>bool</code> default = <code>False</code></dt>
+<dd>experimental feature that packs model training into
+separate process which is killed upon training completion
+by default is not used</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>tuple</code> <code>experiment</code>, <code>dataset</code> <code>instances</code> of <code>corresponding</code> <code>classes</code> <code>from</code> <a title="topicnet" href="../index.html"><code>topicnet</code></a></dt>
+<dd>&nbsp;</dd>
+</dl></section>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">def build_experiment_environment_from_yaml_config(yaml_string, experiment_id,
-                                                  save_path, force_single_thread=False):
-    settings, regs, model, dataset = parse(yaml_string, force_single_thread)
+                                                  save_path, force_separate_thread=False):
+    &#34;&#34;&#34;
+    Wraps up parameter extraction and class instances creation
+    from yaml formatted string
+    together with the method that builds experiment pipeline from
+    given experiment parameters (model, cubes, regularizers, etc)
+
+    Parameters
+    ----------
+    yaml_string: str
+        config that contains the whole experiment pipeline description
+        with its parameters
+    save_path: str
+        path to the folder to save experiment logs and models
+    experiment_id: str
+        name of the experiment folder
+    force_separate_thread: bool default = False
+        experimental feature that packs model training into
+        separate process which is killed upon training completion
+        by default is not used
+
+    Returns
+    -------
+
+    tuple experiment, dataset instances of corresponding classes from topicnet
+    &#34;&#34;&#34;
+    settings, regs, model, dataset = parse(yaml_string, force_separate_thread)
     # TODO: handle dynamic addition of regularizers
     experiment = Experiment(experiment_id=experiment_id, save_path=save_path, topic_model=model)
     experiment.build(settings)
@@ -1090,14 +1158,14 @@ <h2 id="returns">Returns</h2>
 </details>
 </dd>
 <dt id="topicnet.cooking_machine.config_parser.parse"><code class="name flex">
-<span>def <span class="ident">parse</span></span>(<span>yaml_string, force_single_thread=False)</span>
+<span>def <span class="ident">parse</span></span>(<span>yaml_string, force_separate_thread=False)</span>
 </code></dt>
 <dd>
 <section class="desc"><h2 id="parameters">Parameters</h2>
 <dl>
 <dt><strong><code>yaml_string</code></strong> :&ensp;<code>str</code></dt>
 <dd>&nbsp;</dd>
-<dt><strong><code>force_single_thread</code></strong> :&ensp;<code>bool</code></dt>
+<dt><strong><code>force_separate_thread</code></strong> :&ensp;<code>bool</code></dt>
 <dd>&nbsp;</dd>
 </dl>
 <h2 id="returns">Returns</h2>
@@ -1115,12 +1183,12 @@ <h2 id="returns">Returns</h2>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def parse(yaml_string, force_single_thread=False):
+<pre><code class="python">def parse(yaml_string, force_separate_thread=False):
     &#34;&#34;&#34;
     Parameters
     ----------
     yaml_string : str
-    force_single_thread : bool
+    force_separate_thread : bool
 
     Returns
     -------
@@ -1165,7 +1233,7 @@ <h2 id="returns">Returns</h2>
     for stage in parsed[&#39;stages&#39;]:
         for elemtype, elem_args in stage.items():
             settings = build_cube_settings(elemtype.data, elem_args)
-            if force_single_thread:
+            if force_separate_thread:
                 settings[elemtype][&#34;separate_thread&#34;] = False
             cube_settings.append(settings)
 

docs/cooking_machine/cubes/controller_cube.html

@@ -306,7 +306,7 @@ <h2 id="fields">Fields</h2>
 
     See top-level docstring for details.
     &#34;&#34;&#34;
-    def __init__(self, reg_name, score_to_track, tau_converter, max_iters, local_dict=dict()):
+    def __init__(self, reg_name, score_to_track, tau_converter, max_iters, local_dict=None):
         &#34;&#34;&#34;
 
         Parameters
@@ -320,6 +320,9 @@ <h2 id="fields">Fields</h2>
             `max_iters` could be `float(&#34;NaN&#34;)` and `float(&#34;inf&#34;)` values:
             that way agent will continue operating even outside this `RegularizationControllerCube`
         &#34;&#34;&#34;
+        if local_dict is None:
+            local_dict = dict()
+
         self.reg_name = reg_name
         self.tau_converter = tau_converter
         if isinstance(score_to_track, list):
@@ -634,7 +637,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="topicnet.cooking_machine.cubes.controller_cube.ControllerAgent"><code class="flex name class">
 <span>class <span class="ident">ControllerAgent</span></span>
-<span>(</span><span>reg_name, score_to_track, tau_converter, max_iters, local_dict={})</span>
+<span>(</span><span>reg_name, score_to_track, tau_converter, max_iters, local_dict=None)</span>
 </code></dt>
 <dd>
 <section class="desc"><p>Allows to change <code>tau</code> during the <code>_fit</code> method.</p>
@@ -692,7 +695,7 @@ <h2 id="parameters">Parameters</h2>
 
     See top-level docstring for details.
     &#34;&#34;&#34;
-    def __init__(self, reg_name, score_to_track, tau_converter, max_iters, local_dict=dict()):
+    def __init__(self, reg_name, score_to_track, tau_converter, max_iters, local_dict=None):
         &#34;&#34;&#34;
 
         Parameters
@@ -706,6 +709,9 @@ <h2 id="parameters">Parameters</h2>
             `max_iters` could be `float(&#34;NaN&#34;)` and `float(&#34;inf&#34;)` values:
             that way agent will continue operating even outside this `RegularizationControllerCube`
         &#34;&#34;&#34;
+        if local_dict is None:
+            local_dict = dict()
+
         self.reg_name = reg_name
         self.tau_converter = tau_converter
         if isinstance(score_to_track, list):

docs/cooking_machine/cubes/cube_creator.html

@@ -529,7 +529,7 @@ <h3>Class variables</h3>
 <dl>
 <dt id="topicnet.cooking_machine.cubes.cube_creator.CubeCreator.DEFAULT_SEED_VALUE"><code class="name">var <span class="ident">DEFAULT_SEED_VALUE</span></code></dt>
 <dd>
-<section class="desc"><p>int(x=0) -&gt; integer
+<section class="desc"><p>int([x]) -&gt; integer
 int(x, base=10) -&gt; integer</p>
 <p>Convert a number or string to an integer, or return 0 if no arguments
 are given.

docs/cooking_machine/cubes/index.html

@@ -19,7 +19,7 @@
 <header>
 <h1 class="title">Module <code>topicnet.cooking_machine.cubes</code></h1>
 </header>
-<p>Cubes and their Strategies</p>
+<h1 id="cubes-and-their-strategies">Cubes and their Strategies</h1>
 <p>Cube types:</p>
 <ul>
 <li><code>BaseCube</code> — a parent class for all the Cubes</li>
@@ -140,4 +140,4 @@ <h1><code>TopicNet</code> library documentation </h1>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
 <script>hljs.initHighlightingOnLoad()</script>
 </body>
-</html>
+</html>