1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
|
<!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/html; charset=utf-8" />
<title>Overview — NVIDIA Nsight Systems export documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: false,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="JSON and Text Format Description" href="json_text_format.html" />
<link rel="prev" title="NVIDIA Nsight Systems reports export documentation" href="index.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="json_text_format.html" title="JSON and Text Format Description"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="NVIDIA Nsight Systems reports export documentation"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">NVIDIA Nsight Systems export documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1>
<p>This tool is designed to export raw data collected by NVIDIA Nsight Systems.
It does no data processing other than conversion to the selected format. It’s
available as <cite>export</cite> command in <cite>nsys</cite> CLI in Windows and Linux
distributions of Nsight Systems.</p>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>If invoked with <code class="docutils literal"><span class="pre">-h,</span> <span class="pre">--help</span></code> option the tool will print usage instructions:</p>
<div class="highlight-text"><div class="highlight"><pre><span></span>usage: nsys export [<args>] [qdrep-file]
args:
-h, --help
This help message.
-o, --output=
Path to results file.
Default is name of input file with modified extension.
-t, --type=
Possible values are: sqlite, hdf, text, json, info.
Export format type.
-f, --force-overwrite=
Possible values are 'true' or 'false'.
If true, overwrite an existing result file.
Default is 'false'.
-q, --quiet=
Possible values are 'true' or 'false'.
If true, don't display progress bar.
Default is 'false'.
--separate-strings=
Possible values are 'true' or 'false'.
Output stored strings and thread names separately - one value per line.
This affects JSON and text output only.
Default is 'false'.
</pre></div>
</div>
<p>Typically, you will only need to pass the path to Nsight Systems report file
and desired output format: <code class="docutils literal"><span class="pre">./nsys</span> <span class="pre">export</span> <span class="pre">--type</span> <span class="pre">sqlite</span> <span class="pre">path/to/some.qdrep</span></code>.
This will export given report into SQLite database file located in current
directory and named <code class="docutils literal"><span class="pre">some.sqlite</span></code>.</p>
</div>
<div class="section" id="known-issues">
<h2>Known issues<a class="headerlink" href="#known-issues" title="Permalink to this headline">¶</a></h2>
<p>Export to an SQLite database will fail, if the destination filesystem does
not support file locking. The error message will mention:</p>
<div class="highlight-text"><div class="highlight"><pre><span></span>std::exception::what: database is locked
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Overview</a><ul>
<li><a class="reference internal" href="#usage">Usage</a></li>
<li><a class="reference internal" href="#known-issues">Known issues</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">NVIDIA Nsight Systems reports export documentation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="json_text_format.html"
title="next chapter">JSON and Text Format Description</a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="json_text_format.html" title="JSON and Text Format Description"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="NVIDIA Nsight Systems reports export documentation"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">NVIDIA Nsight Systems export documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2020, NVIDIA.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.3.
</div>
</body>
</html>
|