Deploy to GitHub Pages: dce0383f

develop/api_doc/fluid/io.html

@@ -178,7 +178,7 @@
 <h2>save_vars<a class="headerlink" href="#save-vars" title="Permalink to this headline">¶</a></h2>
 <dl class="function">
 <dt>
-<code class="descclassname">paddle.fluid.io.</code><code class="descname">save_vars</code><span class="sig-paren">(</span><em>executor</em>, <em>dirname</em>, <em>main_program=None</em>, <em>vars=None</em>, <em>predicate=None</em>, <em>save_file_name=None</em><span class="sig-paren">)</span></dt>
+<code class="descclassname">paddle.fluid.io.</code><code class="descname">save_vars</code><span class="sig-paren">(</span><em>executor</em>, <em>dirname</em>, <em>main_program=None</em>, <em>vars=None</em>, <em>predicate=None</em>, <em>filename=None</em><span class="sig-paren">)</span></dt>
 <dd><p>Save variables to directory by executor.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
@@ -198,8 +198,9 @@
 as a bool. If it returns true, the corresponding input variable will be saved.
 :param vars: variables need to be saved. If vars is specified, program &amp; predicate
 will be ignored
-:param save_file_name: The name of a single file that all vars are saved to.
-If it is None, save variables to separate files.</p>
+:param filename: The name of a single file that all vars are saved to.</p>
+<blockquote>
+<div>If it is None, save variables to separate files.</div></blockquote>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -215,7 +216,7 @@ If it is None, save variables to separate files.</p>
 <h2>save_params<a class="headerlink" href="#save-params" title="Permalink to this headline">¶</a></h2>
 <dl class="function">
 <dt>
-<code class="descclassname">paddle.fluid.io.</code><code class="descname">save_params</code><span class="sig-paren">(</span><em>executor</em>, <em>dirname</em>, <em>main_program=None</em>, <em>save_file_name=None</em><span class="sig-paren">)</span></dt>
+<code class="descclassname">paddle.fluid.io.</code><code class="descname">save_params</code><span class="sig-paren">(</span><em>executor</em>, <em>dirname</em>, <em>main_program=None</em>, <em>filename=None</em><span class="sig-paren">)</span></dt>
 <dd><p>Save all parameters to directory with executor.</p>
 </dd></dl>
 
@@ -224,7 +225,7 @@ If it is None, save variables to separate files.</p>
 <h2>save_persistables<a class="headerlink" href="#save-persistables" title="Permalink to this headline">¶</a></h2>
 <dl class="function">
 <dt>
-<code class="descclassname">paddle.fluid.io.</code><code class="descname">save_persistables</code><span class="sig-paren">(</span><em>executor</em>, <em>dirname</em>, <em>main_program=None</em>, <em>save_file_name=None</em><span class="sig-paren">)</span></dt>
+<code class="descclassname">paddle.fluid.io.</code><code class="descname">save_persistables</code><span class="sig-paren">(</span><em>executor</em>, <em>dirname</em>, <em>main_program=None</em>, <em>filename=None</em><span class="sig-paren">)</span></dt>
 <dd><p>Save all persistables to directory with executor.</p>
 </dd></dl>
 
@@ -233,7 +234,7 @@ If it is None, save variables to separate files.</p>
 <h2>load_vars<a class="headerlink" href="#load-vars" title="Permalink to this headline">¶</a></h2>
 <dl class="function">
 <dt>
-<code class="descclassname">paddle.fluid.io.</code><code class="descname">load_vars</code><span class="sig-paren">(</span><em>executor</em>, <em>dirname</em>, <em>main_program=None</em>, <em>vars=None</em>, <em>predicate=None</em>, <em>load_file_name=None</em><span class="sig-paren">)</span></dt>
+<code class="descclassname">paddle.fluid.io.</code><code class="descname">load_vars</code><span class="sig-paren">(</span><em>executor</em>, <em>dirname</em>, <em>main_program=None</em>, <em>vars=None</em>, <em>predicate=None</em>, <em>filename=None</em><span class="sig-paren">)</span></dt>
 <dd><p>Load variables from directory by executor.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
@@ -253,8 +254,9 @@ If it is None, save variables to separate files.</p>
 as a bool. If it returns true, the corresponding input variable will be loaded.
 :param vars: variables need to be loaded. If vars is specified, program &amp;
 predicate will be ignored
-:param load_file_name: The name of the single file that all vars are loaded from.
-If it is None, load variables from separate files.</p>
+:param filename: The name of the single file that all vars are loaded from.</p>
+<blockquote>
+<div>If it is None, load variables from separate files.</div></blockquote>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -270,7 +272,7 @@ If it is None, load variables from separate files.</p>
 <h2>load_params<a class="headerlink" href="#load-params" title="Permalink to this headline">¶</a></h2>
 <dl class="function">
 <dt>
-<code class="descclassname">paddle.fluid.io.</code><code class="descname">load_params</code><span class="sig-paren">(</span><em>executor</em>, <em>dirname</em>, <em>main_program=None</em>, <em>load_file_name=None</em><span class="sig-paren">)</span></dt>
+<code class="descclassname">paddle.fluid.io.</code><code class="descname">load_params</code><span class="sig-paren">(</span><em>executor</em>, <em>dirname</em>, <em>main_program=None</em>, <em>filename=None</em><span class="sig-paren">)</span></dt>
 <dd><p>load all parameters from directory by executor.</p>
 </dd></dl>
 
@@ -279,7 +281,7 @@ If it is None, load variables from separate files.</p>
 <h2>load_persistables<a class="headerlink" href="#load-persistables" title="Permalink to this headline">¶</a></h2>
 <dl class="function">
 <dt>
-<code class="descclassname">paddle.fluid.io.</code><code class="descname">load_persistables</code><span class="sig-paren">(</span><em>executor</em>, <em>dirname</em>, <em>main_program=None</em>, <em>load_file_name=None</em><span class="sig-paren">)</span></dt>
+<code class="descclassname">paddle.fluid.io.</code><code class="descname">load_persistables</code><span class="sig-paren">(</span><em>executor</em>, <em>dirname</em>, <em>main_program=None</em>, <em>filename=None</em><span class="sig-paren">)</span></dt>
 <dd><p>load all persistables from directory by executor.</p>
 </dd></dl>
 
@@ -288,32 +290,30 @@ If it is None, load variables from separate files.</p>
 <h2>save_inference_model<a class="headerlink" href="#save-inference-model" title="Permalink to this headline">¶</a></h2>
 <dl class="function">
 <dt>
-<code class="descclassname">paddle.fluid.io.</code><code class="descname">save_inference_model</code><span class="sig-paren">(</span><em>dirname</em>, <em>feeded_var_names</em>, <em>target_vars</em>, <em>executor</em>, <em>main_program=None</em>, <em>save_file_name=None</em><span class="sig-paren">)</span></dt>
+<code class="descclassname">paddle.fluid.io.</code><code class="descname">save_inference_model</code><span class="sig-paren">(</span><em>dirname</em>, <em>feeded_var_names</em>, <em>target_vars</em>, <em>executor</em>, <em>main_program=None</em>, <em>model_filename=None</em>, <em>params_filename=None</em><span class="sig-paren">)</span></dt>
 <dd><p>Build a model especially for inference,
 and save it to directory by the executor.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 <li><strong>dirname</strong> &#8211; directory path</li>
 <li><strong>feeded_var_names</strong> &#8211; Names of variables that need to be feeded data during inference</li>
 <li><strong>target_vars</strong> &#8211; Variables from which we can get inference results.</li>
 <li><strong>executor</strong> &#8211; executor that save inference model</li>
 <li><strong>main_program</strong> &#8211; original program, which will be pruned to build the inference model.
 Default default_main_program().</li>
-<li><strong>save_file_name</strong> &#8211; The name of a single file that all parameters are saved to.</li>
+<li><strong>model_filename</strong> &#8211; The name of file to save inference program.
+If not specified, default filename <cite>__model__</cite> will be used.</li>
+<li><strong>params_filename</strong> &#8211; The name of file to save parameters.
+It is used for the case that all parameters are saved in a single binary file.
+If not specified, parameters are considered saved in separate files.</li>
 </ul>
 </td>
 </tr>
-</tbody>
-</table>
-<p>If it is None, save parameters to separate files.</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
+</td>
 </tr>
 </tbody>
 </table>
@@ -324,30 +324,28 @@ Default default_main_program().</li>
 <h2>load_inference_model<a class="headerlink" href="#load-inference-model" title="Permalink to this headline">¶</a></h2>
 <dl class="function">
 <dt>
-<code class="descclassname">paddle.fluid.io.</code><code class="descname">load_inference_model</code><span class="sig-paren">(</span><em>dirname</em>, <em>executor</em>, <em>load_file_name=None</em><span class="sig-paren">)</span></dt>
+<code class="descclassname">paddle.fluid.io.</code><code class="descname">load_inference_model</code><span class="sig-paren">(</span><em>dirname</em>, <em>executor</em>, <em>model_filename=None</em>, <em>params_filename=None</em><span class="sig-paren">)</span></dt>
 <dd><p>Load inference model from a directory</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 <li><strong>dirname</strong> &#8211; directory path</li>
 <li><strong>executor</strong> &#8211; executor that load inference model</li>
-<li><strong>load_file_name</strong> &#8211; The name of the single file that all parameters are loaded from.</li>
+<li><strong>model_filename</strong> &#8211; The name of file to load inference program.
+If not specified, default filename <cite>__model__</cite> will be used.</li>
+<li><strong>params_filename</strong> &#8211; The name of file to load parameters.
+It is used for the case that all parameters are saved in a single binary file.
+If not specified, parameters are considered saved in separate files.</li>
 </ul>
 </td>
 </tr>
-</tbody>
-</table>
-<p>If it is None, load parameters from separate files.</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">[program, feed_target_names, fetch_targets]
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">[program, feed_target_names, fetch_targets]
 program: program especially for inference.
 feed_target_names: Names of variables that need to feed data
-fetch_targets: Variables from which we can get inference results.</td>
+fetch_targets: Variables from which we can get inference results.</p>
+</td>
 </tr>
 </tbody>
 </table>