php-doc-en/reference/fann/functions/fann-save.xml
2013-08-28 19:06:34 +00:00

89 lines
2.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fann-save" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>fann_save</refname>
<refpurpose>Saves the entire network to a configuration file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fann_save</methodname>
<methodparam><type>resource</type><parameter>ann</parameter></methodparam>
<methodparam><type>string</type><parameter>configuration_file</parameter></methodparam>
</methodsynopsis>
<para>
Saves the entire network to a configuration file.
</para>
<para>
The configuration file contains all information about the neural network and enables
<function>fann_create_from_file</function> to create an exact copy of the neural network
and all of the parameters associated with the neural network.
</para>
<para>
These three parameters (<function>fann_set_callback</function>, <function>fann_set_error_log</function>,
<function>fann_set_user_data</function>) are NOT saved to the file because they cannot safely be ported
to a different location. Also temporary parameters generated during training like <function>fann_get_MSE</function>
is not saved.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>ann</parameter></term>
<listitem>
&fann.ann.description;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>configuration_file</parameter></term>
<listitem>
<para>
The configuration file path.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
&fann.return.bool;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fann_create_from_file</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->