blob: bec9ef1e75cf3a9cb2591207c7a1f83d70a0c094 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: /work/mxnet/3rdparty/dmlc-core/include/dmlc/parameter.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_82e31a22178767beedddc7597fd1ecb6.html">dmlc-core</a></li><li class="navelem"><a class="el" href="dir_7dd5b88db83ff474628c03c453739a90.html">include</a></li><li class="navelem"><a class="el" href="dir_e30967e3ab51f65ad4b50dd298ccf4e7.html">dmlc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">parameter.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provide lightweight util to do parameter setup and checking.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;cstddef&gt;</code><br />
<code>#include &lt;cstdlib&gt;</code><br />
<code>#include &lt;cmath&gt;</code><br />
<code>#include &lt;sstream&gt;</code><br />
<code>#include &lt;limits&gt;</code><br />
<code>#include &lt;map&gt;</code><br />
<code>#include &lt;set&gt;</code><br />
<code>#include &lt;typeinfo&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &lt;algorithm&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &lt;stdexcept&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;iomanip&gt;</code><br />
<code>#include &lt;cerrno&gt;</code><br />
<code>#include &quot;<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h_source.html">./base.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="json_8h_source.html">./json.h</a>&quot;</code><br />
<code>#include &quot;./logging.h&quot;</code><br />
<code>#include &quot;<a class="el" href="type__traits_8h_source.html">./type_traits.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="optional_8h_source.html">./optional.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="strtonum_8h_source.html">./strtonum.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for parameter.h:</div>
<div class="dyncontent">
<div class="center"><img src="parameter_8h__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2parameter_8h" alt=""/></div>
<map name="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2parameter_8h" id="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2parameter_8h">
<area shape="rect" id="node18" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html" title="./base.h" alt="" coords="707,259,780,285"/>
<area shape="rect" id="node22" href="json_8h.html" title="Lightweight JSON Reader/Writer that read save into C++ data structs. This includes STL composites and..." alt="" coords="1239,109,1309,136"/>
<area shape="rect" id="node26" href="type__traits_8h.html" title="type traits information header " alt="" coords="886,184,998,211"/>
<area shape="rect" id="node30" href="optional_8h.html" title="Container to hold optional data. " alt="" coords="1821,109,1916,136"/>
<area shape="rect" id="node33" href="strtonum_8h.html" title="A faster implementation of strtof and strtod. " alt="" coords="433,184,534,211"/>
<area shape="rect" id="node21" href="build__config__default_8h.html" title="Default detection logic for fopen64 and other symbols. May be overriden by CMake. ..." alt="" coords="783,333,984,360"/>
<area shape="rect" id="node31" href="common_8h.html" title="defines some common utility function. " alt="" coords="2007,184,2106,211"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="parameter_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2parameter_8hdep" alt=""/></div>
<map name="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2parameter_8hdep" id="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2parameter_8hdep">
<area shape="rect" id="node2" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html" title="/work/mxnet/3rdparty\l/dmlc&#45;core/include/dmlc\l/registry.h" alt="" coords="2071,109,2249,165"/>
<area shape="rect" id="node13" href="operator__util_8h.html" title="Utility functions and registries to help quickly build new operators. [Deprecated] Use the register f..." alt="" coords="2069,1403,2235,1444"/>
<area shape="rect" id="node22" href="include_2mxnet_2base_8h.html" title="/work/mxnet/include\l/mxnet/base.h" alt="" coords="1264,941,1419,983"/>
<area shape="rect" id="node34" href="op_8h.html" title="Operator information structor. " alt="" coords="514,325,731,366"/>
<area shape="rect" id="node37" href="layout_8h.html" title="Layout expression. The layout is composed of upper cases, lower cases and numbers, where upper case indicates a (super&#45;)dimension and the corresponding lower case with factor size indicates the split (sub&#45;)dimension. For example, NCHW16c can describe a 5&#45;D tensor of [batch_size, channel, height, width, channel_block]. Here sub&#45;dimension channel_block=16 is the split of super&#45;dimension C (channel). " alt="" coords="43,421,229,477"/>
<area shape="rect" id="node38" href="cuda__utils_8h.html" title="Common CUDA utilities. " alt="" coords="2502,117,2690,158"/>
<area shape="rect" id="node3" href="data_8h.html" title="defines common input data structure, and interface for handling the input data " alt="" coords="2071,213,2249,269"/>
<area shape="rect" id="node5" href="include_2mxnet_2io_8h.html" title="/work/mxnet/include\l/mxnet/io.h" alt="" coords="1893,1217,2048,1258"/>
<area shape="rect" id="node6" href="include_2mxnet_2ndarray_8h.html" title="/work/mxnet/include\l/mxnet/ndarray.h" alt="" coords="1264,1120,1419,1161"/>
<area shape="rect" id="node12" href="include_2mxnet_2operator_8h.html" title="/work/mxnet/include\l/mxnet/operator.h" alt="" coords="1843,1313,1997,1355"/>
<area shape="rect" id="node19" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2base_8h.html" title="Configuration of nnvm as well as basic data structure. " alt="" coords="677,213,862,269"/>
<area shape="rect" id="node4" href="threadediter_8h.html" title="thread backed iterator that can be used to implement general thread&#45;based pipeline such as prefetch a..." alt="" coords="2045,317,2224,373"/>
<area shape="rect" id="node7" href="packed__func_8h.html" title="Type&#45;erased function used across MXNET API. " alt="" coords="1486,1209,1661,1265"/>
<area shape="rect" id="node10" href="include_2mxnet_2executor_8h.html" title="/work/mxnet/include\l/mxnet/executor.h" alt="" coords="1728,1403,1883,1444"/>
<area shape="rect" id="node11" href="include_2mxnet_2op__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/op_attr_types.h" alt="" coords="721,1217,895,1258"/>
<area shape="rect" id="node15" href="imperative_8h.html" title="/work/mxnet/include\l/mxnet/imperative.h" alt="" coords="753,1403,908,1444"/>
<area shape="rect" id="node16" href="utils_8h.html" title="Basic utilility functions. " alt="" coords="597,1492,785,1533"/>
<area shape="rect" id="node18" href="include_2mxnet_2kvstore_8h.html" title="/work/mxnet/include\l/mxnet/kvstore.h" alt="" coords="1149,1217,1304,1258"/>
<area shape="rect" id="node8" href="include_2mxnet_2runtime_2registry_8h.html" title="/work/mxnet/include\l/mxnet/runtime/registry.h" alt="" coords="1480,1313,1667,1355"/>
<area shape="rect" id="node9" href="api__registry_8h.html" title="This file contains utilities related to the MXNet&#39;s global function registry. " alt="" coords="1494,1403,1653,1444"/>
<area shape="rect" id="node14" href="include_2mxnet_2graph__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/graph_attr_types.h" alt="" coords="703,1313,897,1355"/>
<area shape="rect" id="node17" href="exec__utils_8h.html" title="Common utility functions for executors. " alt="" coords="597,1581,785,1623"/>
<area shape="rect" id="node20" href="graph_8h.html" title="Configuation of nnvm as well as basic data structure. " alt="" coords="963,629,1149,685"/>
<area shape="rect" id="node29" href="pass_8h.html" title="Pass that can be applied to a graph. " alt="" coords="651,733,837,789"/>
<area shape="rect" id="node30" href="pass__functions_8h.html" title="Pass functions that simply redirect the calls to ApplyPass. " alt="" coords="129,837,314,893"/>
<area shape="rect" id="node31" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2node_8h.html" title="Graph node data structure. " alt="" coords="794,421,979,477"/>
<area shape="rect" id="node32" href="symbolic_8h.html" title="Symbolic graph construction API. " alt="" coords="925,525,1110,581"/>
<area shape="rect" id="node33" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2op__attr__types_8h.html" title="Data structures that can appear in operator attributes. " alt="" coords="303,525,489,581"/>
<area shape="rect" id="node35" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2tuple_8h.html" title="Data structure Tuple and TShape to store dynamic sized shapes. " alt="" coords="253,421,438,477"/>
<area shape="rect" id="node21" href="include_2mxnet_2tuple_8h.html" title="Data structure Tuple and TShape to store dynamic sized shapes. " alt="" coords="541,845,696,886"/>
<area shape="rect" id="node23" href="engine_8h.html" title="Engine that schedules all the operations according to dependency. " alt="" coords="693,1031,848,1072"/>
<area shape="rect" id="node24" href="resource_8h.html" title="Global resource allocation handling. " alt="" coords="896,1120,1051,1161"/>
<area shape="rect" id="node25" href="storage_8h.html" title="Storage manager across multiple devices. " alt="" coords="1149,1031,1304,1072"/>
<area shape="rect" id="node26" href="random__generator_8h.html" title="Parallel random number generator. " alt="" coords="872,1031,1075,1072"/>
<area shape="rect" id="node27" href="rtc_8h.html" title="/work/mxnet/include\l/mxnet/rtc.h" alt="" coords="1379,1031,1533,1072"/>
<area shape="rect" id="node28" href="tensor__blob_8h.html" title="TBlob class that holds common representation of arbirary dimension tensor, can be used to transformed..." alt="" coords="1557,1031,1717,1072"/>
<area shape="rect" id="node36" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2graph__attr__types_8h.html" title="Data structures that can appear in graph attributes. " alt="" coords="173,733,358,789"/>
</map>
</div>
</div>
<p><a href="parameter_8h_source.html">Go to the source code of this file.</a></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provide lightweight util to do parameter setup and checking. </p>
<p>Copyright (c) 2015 by Contributors </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:42 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>