Skip to content

P
Paddle

BaiXuePrincess / Paddle
与 Fork 源项目一致

Fork自 PaddlePaddle / Paddle

通知 1
Star 1
Fork 0
P
Paddle
切换分支/标签
查找文件 普通视图历史永久链接Permalink
pfsclient.html 17.1 KB
Newer Older
T
Deploy to GitHub Pages: ffbd1ef1b0d5b41db1a6769062186f56a302d03c  
Travis CI 已提交
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 


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>PFSClient &mdash; PaddlePaddle  documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
  

  
  
        <link rel="index" title="Index"
              href="../../../genindex.html"/>
        <link rel="search" title="Search" href="../../../search.html"/>
    <link rel="top" title="PaddlePaddle  documentation" href="../../../index.html"/> 

  <link rel="stylesheet" href="https://cdn.jsdelivr.net/perfect-scrollbar/0.6.14/css/perfect-scrollbar.min.css" type="text/css" />
  <link rel="stylesheet" href="../../../_static/css/override.css" type="text/css" />
  <script>
  var _hmt = _hmt || [];
  (function() {
    var hm = document.createElement("script");
    hm.src = "//hm.baidu.com/hm.js?b9a314ab40d04d805655aab1deee08ba";
    var s = document.getElementsByTagName("script")[0]; 
    s.parentNode.insertBefore(hm, s);
  })();
  </script>

  

  
  <script src="../../../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  
  <header class="site-header">
    <div class="site-logo">
      <a href="/"><img src="../../../_static/images/PP_w.png"></a>
    </div>
    <div class="site-nav-links">
      <div class="site-menu">
T
Deploy to GitHub Pages: 7b81055395daa0ce3d02ccb060476c410ee4eb0f  
Travis CI 已提交
65 
        <a class="fork-on-github" href="https://github.com/PaddlePaddle/Paddle" target="_blank"><i class="fa fa-github"></i>Fork me on Github</a>
T
Deploy to GitHub Pages: ffbd1ef1b0d5b41db1a6769062186f56a302d03c  
Travis CI 已提交
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 
        <div class="language-switcher dropdown">
          <a type="button" data-toggle="dropdown">
            <span>English</span>
            <i class="fa fa-angle-up"></i>
            <i class="fa fa-angle-down"></i>
          </a>
          <ul class="dropdown-menu">
            <li><a href="/doc_cn">中文</a></li>
            <li><a href="/doc">English</a></li>
          </ul>
        </div>
        <ul class="site-page-links">
          <li><a href="/">Home</a></li>
        </ul>
      </div>
      <div class="doc-module">
        
        <ul>
<li class="toctree-l1"><a class="reference internal" href="../../../getstarted/index_en.html">GET STARTED</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../howto/index_en.html">HOW TO</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../api/index_en.html">API</a></li>
</ul>

        
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>        
      </div>
    </div>
  </header>
  
  <div class="main-content-wrap">

    
    <nav class="doc-menu-vertical" role="navigation">
        
          
          <ul>
<li class="toctree-l1"><a class="reference internal" href="../../../getstarted/index_en.html">GET STARTED</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../getstarted/build_and_install/index_en.html">Install and Build</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../../getstarted/build_and_install/docker_install_en.html">PaddlePaddle in Docker Containers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../getstarted/build_and_install/build_from_source_en.html">Installing from Sources</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../howto/index_en.html">HOW TO</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../howto/usage/cmd_parameter/index_en.html">Set Command-line Parameters</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../../howto/usage/cmd_parameter/use_case_en.html">Use Case</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../howto/usage/cmd_parameter/arguments_en.html">Argument Outline</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../howto/usage/cmd_parameter/detail_introduction_en.html">Detail Description</a></li>
</ul>
</li>
T
Deploy to GitHub Pages: 63ffe5250a120ff430469b8d000deb2b031c4881  
Travis CI 已提交
123 124 125 126 127 
<li class="toctree-l2"><a class="reference internal" href="../../../howto/usage/cluster/cluster_train_en.html">PaddlePaddle Distributed Training</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../howto/usage/cluster/cluster_train_en.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../howto/usage/cluster/cluster_train_en.html#preparations">Preparations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../howto/usage/cluster/cluster_train_en.html#command-line-arguments">Command-line arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../howto/usage/cluster/cluster_train_en.html#use-cluster-platforms-or-cluster-management-tools">Use cluster platforms or cluster management tools</a></li>
T
Deploy to GitHub Pages: ffbd1ef1b0d5b41db1a6769062186f56a302d03c  
Travis CI 已提交
128 129 
<li class="toctree-l2"><a class="reference internal" href="../../../howto/usage/k8s/k8s_en.html">Paddle On Kubernetes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../howto/usage/k8s/k8s_aws_en.html">Distributed PaddlePaddle Training on AWS with Kubernetes</a></li>
T
Deploy to GitHub Pages: 111812fa3b41797a3940bbcd51e51ff21b799ffe  
Travis CI 已提交
130 
<li class="toctree-l2"><a class="reference internal" href="../../../howto/dev/build_en.html">Build PaddlePaddle from Source Code and Run Unit Test</a></li>
T
Deploy to GitHub Pages: ffbd1ef1b0d5b41db1a6769062186f56a302d03c  
Travis CI 已提交
131 
<li class="toctree-l2"><a class="reference internal" href="../../../howto/dev/new_layer_en.html">Write New Layers</a></li>
T
Deploy to GitHub Pages: f122a5da2f27038b48f6ed607e296d762050e920  
Travis CI 已提交
132 
<li class="toctree-l2"><a class="reference internal" href="../../../howto/dev/contribute_to_paddle_en.html">Contribute Code</a></li>
T
Deploy to GitHub Pages: 7c088b529c97f6dc3c28d60dd0510a64bce61312  
Travis CI 已提交
133 134 135 136 
<li class="toctree-l2"><a class="reference internal" href="../../../howto/deep_model/rnn/index_en.html">RNN Models</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../../howto/deep_model/rnn/rnn_config_en.html">RNN Configuration</a></li>
</ul>
</li>
T
Deploy to GitHub Pages: ffbd1ef1b0d5b41db1a6769062186f56a302d03c  
Travis CI 已提交
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 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 
<li class="toctree-l2"><a class="reference internal" href="../../../howto/optimization/gpu_profiling_en.html">Tune GPU Performance</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../api/index_en.html">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../api/v2/model_configs.html">Model Configuration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/config/activation.html">Activation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/config/layer.html">Layers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/config/evaluators.html">Evaluators</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/config/optimizer.html">Optimizer</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/config/pooling.html">Pooling</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/config/networks.html">Networks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/config/attr.html">Parameter Attribute</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/v2/data.html">Data Reader Interface and DataSets</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/v2/run_logic.html">Training and Inference</a></li>
</ul>
</li>
</ul>

        
    </nav>
    
    <section class="doc-content-wrap">

      

 







<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
      
    <li>PFSClient</li>
  </ul>
</div>
      
      <div class="wy-nav-content" id="doc-content">
        <div class="rst-content">
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="pfsclient">
<span id="pfsclient"></span><h1>PFSClient<a class="headerlink" href="#pfsclient" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<span id="description"></span><h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal"><span class="pre">pfs</span></code> command is a Command Line Interface to manage your files on PaddlePaddle Cloud</p>
</div>
<div class="section" id="synopsis">
<span id="synopsis"></span><h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">paddle</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="n">pfs</span> <span class="o">&lt;</span><span class="n">subcommand</span><span class="o">&gt;</span> <span class="p">[</span><span class="n">parameters</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="options">
<span id="options"></span><h2>Options<a class="headerlink" href="#options" title="Permalink to this headline"></a></h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">--</span><span class="n">profile</span> <span class="p">(</span><span class="n">string</span><span class="p">)</span>
    <span class="n">Use</span> <span class="n">a</span> <span class="n">specific</span> <span class="n">profile</span> <span class="kn">from</span> <span class="nn">your</span> <span class="n">credential</span> <span class="n">file</span><span class="o">.</span>

<span class="o">--</span><span class="n">help</span> <span class="p">(</span><span class="n">string</span><span class="p">)</span>
    <span class="n">Display</span> <span class="n">more</span> <span class="n">information</span> <span class="n">about</span> <span class="n">command</span>

<span class="o">--</span><span class="n">version</span>
    <span class="n">Output</span> <span class="n">version</span> <span class="n">information</span> <span class="ow">and</span> <span class="n">exit</span>

<span class="o">--</span><span class="n">debug</span>
    <span class="n">Show</span> <span class="n">detailed</span> <span class="n">debugging</span> <span class="n">log</span> 
    
<span class="o">--</span><span class="n">only</span><span class="o">-</span><span class="n">show</span><span class="o">-</span><span class="n">errors</span> <span class="p">(</span><span class="n">boolean</span><span class="p">)</span> 
    <span class="n">Only</span> <span class="n">errors</span> <span class="ow">and</span> <span class="n">warnings</span> <span class="n">are</span> <span class="n">displayed</span><span class="o">.</span> <span class="n">All</span> <span class="n">other</span> <span class="n">output</span> <span class="ow">is</span> <span class="n">suppressed</span><span class="o">.</span>
</pre></div>
</div>
</div>
<div class="section" id="path-arguments">
<span id="path-arguments"></span><h2>Path Arguments<a class="headerlink" href="#path-arguments" title="Permalink to this headline"></a></h2>
<p>When using a command, we need to specify path arguments. There are two path argument type: <code class="docutils literal"><span class="pre">localpath</span></code> and <code class="docutils literal"><span class="pre">pfspath</span></code>.</p>
<p>A <code class="docutils literal"><span class="pre">pfspath</span></code> begin with <code class="docutils literal"><span class="pre">/pfs</span></code>, eg: <code class="docutils literal"><span class="pre">/pfs/$DATACENTER/home/$USER/folder</span></code>.</p>
<p><a class="reference external" href="https://github.com/PaddlePaddle/Paddle/blob/develop/doc/design/cluster_train/data_dispatch.md#上传训练文件">Here</a> is how to config datacenters.</p>
</div>
<div class="section" id="order-of-path-arguments">
<span id="order-of-path-arguments"></span><h2>order of Path Arguments<a class="headerlink" href="#order-of-path-arguments" title="Permalink to this headline"></a></h2>
<p>Commonly, if there are two path arguments, the first is the source, and the second is the destination.</p>
</div>
<div class="section" id="subcommonds">
<span id="subcommonds"></span><h2>Subcommonds<a class="headerlink" href="#subcommonds" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>rm - remove files or directories</li>
</ul>
<div class="highlight-default"><div class="highlight"><pre><span></span>Synopsis:
    rm [-r] [-v] &lt;PFSPath&gt; ...

Options:
    -r 
        Remove directories and their contents recursively 
    -v      
        Cause rm to be verbose, showing files after they are removed.
    
Examples:
    paddle pfs rm /pfs/$DATACENTER/home/$USER/file
    paddle pfs rm -r /pfs/$DATACENTER/home/$USER/folder
</pre></div>
</div>
<ul class="simple">
<li>mv - move (rename) files</li>
</ul>
<div class="highlight-default"><div class="highlight"><pre><span></span>Synopsis:
    mv [-f | -n] [-v] &lt;LocalPath&gt; &lt;PFSPath&gt;
    mv [-f | -n] [-v] &lt;LocalPath&gt; ... &lt;PFSPath&gt;
    mv [-f | -n] [-v] &lt;PFSPath&gt; &lt;LocalPath&gt; 
    mv [-f | -n] [-v] &lt;PFSPath&gt; ... &lt;LocalPath&gt; 
    mv [-f | -n] [-v] &lt;PFSPath&gt; &lt;PFSPath&gt; 
    mv [-f | -n] [-v] &lt;PFSPath&gt; ... &lt;PFSPath&gt; 
    
Options:
    -f      
        Do not prompt for confirmation before overwriting the destination path.  (The -f option overrides previous -n options.)
    -n      
        Do not overwrite an existing file.  (The -n option overrides previous -f options.)
    -v      
        Cause mv to be verbose, showing files after they are moved.
        
Examples:
    paddle pfs mv ./text1.txt /pfs/$DATACENTER/home/$USER/text1.txt
</pre></div>
</div>
<ul class="simple">
<li>cp - copy files or directories</li>
</ul>
<div class="highlight-default"><div class="highlight"><pre><span></span>Synopsis:
    cp [-r] [-f | -n] [-v] [--preserve--links] &lt;LocalPath&gt; &lt;PFSPath&gt;
    cp [-r] [-f | -n] [-v] [--preserve--links] &lt;LocalPath&gt; ... &lt;PFSPath&gt;
    cp [-r] [-f | -n] [-v] [--preserve--links] &lt;PFSPath&gt; &lt;LocalPath&gt; 
    cp [-r] [-f | -n] [-v] [--preserve--links] &lt;PFSPath&gt; ... &lt;LocalPath&gt;
    cp [-r] [-f | -n] [-v] [--preserve--links] &lt;PFSPath&gt; &lt;PFSPath&gt; 
    cp [-r] [-f | -n] [-v] [--preserve--links] &lt;PFSPath&gt; ... &lt;PFSPath&gt;

Options:
    -r
        Copy directories recursively
    -f      
        Do not prompt for confirmation before overwriting the destination path.  (The -f option overrides previous -n options.)
    -n      
        Do not overwrite an existing file.  (The -n option overrides previous -f options.)
    -v      
        Cause cp to be verbose, showing files after they are copied.
    --preserve--links
       Reserve links when copy links
       
Examples:
    paddle pfs cp ./file /pfs/$DATACENTER/home/$USER/file
    paddle pfs cp /pfs/$DATACENTER/home/$USER/file ./file
</pre></div>
</div>
<ul class="simple">
<li>ls- list files</li>
</ul>
<div class="highlight-default"><div class="highlight"><pre><span></span>Synopsis:
    ls [-r] &lt;PFSPath&gt; ...
    
Options:
    -R
        List directory(ies) recursively

Examples:
    paddle pfs ls  /pfs/$DATACENTER/home/$USER/file
    paddle pfs ls  /pfs/$DATACENTER/home/$USER/folder
</pre></div>
</div>
<ul class="simple">
<li>mkdir - mkdir directory(ies)
Create intermediate directory(ies) as required.</li>
</ul>
<div class="highlight-default"><div class="highlight"><pre><span></span>Synopsis:
    mkdir &lt;PFSPath&gt; ...

Examples:
    paddle pfs mkdir  /pfs/$DATACENTER/home/$USER/folder
</pre></div>
</div>
</div>
</div>


           </div>
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2016, PaddlePaddle developers.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../../../',
            VERSION:'',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            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>
      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
       
  

  
  
    <script type="text/javascript" src="../../../_static/js/theme.js"></script>
  
  
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
  <script src="https://cdn.jsdelivr.net/perfect-scrollbar/0.6.14/js/perfect-scrollbar.jquery.min.js"></script>
  <script src="../../../_static/js/paddle_doc_init.js"></script> 

</body>
</html>