From 6745458eb0d8ddc97d93fee92637663e0e030457 Mon Sep 17 00:00:00 2001
From: Rita Iglesias <ritaiglesias@fb.com>
Date: Mon, 20 Jun 2022 14:32:06 -0300
Subject: [PATCH 1/3] merge

---
 .../generated/torch.cuda.stream.rst.txt       |  15 ++-
 .../torch.nn.utils.prune.identity.rst.txt     |  15 ++-
 docs/master/generated/torch.cuda.stream.html  | 126 +++++++++++++++---
 .../torch.nn.utils.prune.identity.html        | 119 +++++++++++------
 4 files changed, 208 insertions(+), 67 deletions(-)

diff --git a/docs/master/_sources/generated/torch.cuda.stream.rst.txt b/docs/master/_sources/generated/torch.cuda.stream.rst.txt
index 556221357a58..32d7ee2647d1 100644
--- a/docs/master/_sources/generated/torch.cuda.stream.rst.txt
+++ b/docs/master/_sources/generated/torch.cuda.stream.rst.txt
@@ -1,6 +1,13 @@
-torch.cuda.stream
-=================
-
+.. role:: hidden
+    :class: hidden-section
 .. currentmodule:: torch.cuda
 
-.. autofunction:: stream
\ No newline at end of file
+
+Stream
+======
+
+.. autoclass:: Stream
+    :inherited-members:
+    :members:
+
+.. autogenerated from source/_templates/autosummary/class.rst
\ No newline at end of file
diff --git a/docs/master/_sources/generated/torch.nn.utils.prune.identity.rst.txt b/docs/master/_sources/generated/torch.nn.utils.prune.identity.rst.txt
index 8cb212231d15..ac2cf321bb8c 100644
--- a/docs/master/_sources/generated/torch.nn.utils.prune.identity.rst.txt
+++ b/docs/master/_sources/generated/torch.nn.utils.prune.identity.rst.txt
@@ -1,6 +1,13 @@
-torch.nn.utils.prune.identity
-=============================
-
+.. role:: hidden
+    :class: hidden-section
 .. currentmodule:: torch.nn.utils.prune
 
-.. autofunction:: identity
\ No newline at end of file
+
+Identity
+========
+
+.. autoclass:: Identity
+    :inherited-members:
+    :members:
+
+.. autogenerated from source/_templates/autosummary/class.rst
\ No newline at end of file
diff --git a/docs/master/generated/torch.cuda.stream.html b/docs/master/generated/torch.cuda.stream.html
index 6a67a97f9e13..c4c305a1abf9 100644
--- a/docs/master/generated/torch.cuda.stream.html
+++ b/docs/master/generated/torch.cuda.stream.html
@@ -10,14 +10,14 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>torch.cuda.stream &mdash; PyTorch master documentation</title>
+  <title>Stream &mdash; PyTorch master documentation</title>
   
 
   
   
   
   
-    <link rel="canonical" href="https://pytorch.org/docs/stable/generated/torch.cuda.stream.html"/>
+    <link rel="canonical" href="https://pytorch.org/docs/stable/generated/torch.cuda.Stream.html"/>
   
 
   
@@ -41,8 +41,8 @@
   <link rel="stylesheet" href="../_static/css/jit.css" type="text/css" />
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="torch.cuda.synchronize" href="torch.cuda.synchronize.html" />
-    <link rel="prev" title="torch.cuda.set_sync_debug_mode" href="torch.cuda.set_sync_debug_mode.html" />
+    <link rel="next" title="ExternalStream" href="torch.cuda.ExternalStream.html" />
+    <link rel="prev" title="torch.cuda.comm.gather" href="torch.cuda.comm.gather.html" />
 
 <!--
   Search engines should not index the master version of documentation.
@@ -242,7 +242,7 @@
           
 
 <div>
-  <a style="color:#F05732" href="https://pytorch.org/docs/stable/generated/torch.cuda.stream.html">
+  <a style="color:#F05732" href="https://pytorch.org/docs/stable/generated/torch.cuda.Stream.html">
     You are viewing unstable developer preview docs.
     Click here to view docs for latest stable release.
   </a>
@@ -397,13 +397,13 @@
         
           <li><a href="../cuda.html">torch.cuda</a> &gt;</li>
         
-      <li>torch.cuda.stream</li>
+      <li>Stream</li>
     
     
       <li class="pytorch-breadcrumbs-aside">
         
             
-            <a href="../_sources/generated/torch.cuda.stream.rst.txt" rel="nofollow"><img src="../_static/images/view-page-source-icon.svg"></a>
+            <a href="../_sources/generated/torch.cuda.Stream.rst.txt" rel="nofollow"><img src="../_static/images/view-page-source-icon.svg"></a>
           
         
       </li>
@@ -429,21 +429,105 @@
             <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
              <article itemprop="articleBody" id="pytorch-article" class="pytorch-article">
               
-  <section id="torch-cuda-stream">
-<h1>torch.cuda.stream<a class="headerlink" href="#torch-cuda-stream" title="Permalink to this heading">¶</a></h1>
-<dl class="py function">
-<dt class="sig sig-object py" id="torch.cuda.stream">
-<span class="sig-prename descclassname"><span class="pre">torch.cuda.</span></span><span class="sig-name descname"><span class="pre">stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stream</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/torch/cuda.html#stream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch.cuda.stream" title="Permalink to this definition">¶</a></dt>
-<dd><p>Wrapper around the Context-manager StreamContext that
-selects a given stream.</p>
+  <section id="stream">
+<h1>Stream<a class="headerlink" href="#stream" title="Permalink to this heading">¶</a></h1>
+<dl class="py class">
+<dt class="sig sig-object py" id="torch.cuda.Stream">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">torch.cuda.</span></span><span class="sig-name descname"><span class="pre">Stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">priority</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/torch/cuda/streams.html#Stream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch.cuda.Stream" title="Permalink to this definition">¶</a></dt>
+<dd><p>Wrapper around a CUDA stream.</p>
+<p>A CUDA stream is a linear sequence of execution that belongs to a specific
+device, independent from other streams.  See <a class="reference internal" href="../notes/cuda.html#cuda-semantics"><span class="std std-ref">CUDA semantics</span></a> for
+details.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>stream</strong> (<a class="reference internal" href="torch.cuda.Stream.html#torch.cuda.Stream" title="torch.cuda.Stream"><em>Stream</em></a>) – selected stream. This manager is a no-op if it’s
-<code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>device</strong> (<a class="reference internal" href="../tensor_attributes.html#torch.device" title="torch.device"><em>torch.device</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><em>int</em></a><em>, </em><em>optional</em>) – a device on which to allocate
+the stream. If <a class="reference internal" href="torch.cuda.device.html#torch.cuda.device" title="torch.cuda.device"><code class="xref py py-attr docutils literal notranslate"><span class="pre">device</span></code></a> is <code class="docutils literal notranslate"><span class="pre">None</span></code> (default) or a negative
+integer, this will use the current device.</p></li>
+<li><p><strong>priority</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><em>int</em></a><em>, </em><em>optional</em>) – priority of the stream. Can be either
+-1 (high priority) or 0 (low priority). By default, streams have
+priority 0.</p></li>
+</ul>
+</dd>
+</dl>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Although CUDA versions &gt;= 11 support more than two levels of
+priorities, in PyTorch, we only support two levels of priorities.</p>
+</div>
+<dl class="py method">
+<dt class="sig sig-object py" id="torch.cuda.Stream.query">
+<span class="sig-name descname"><span class="pre">query</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/torch/cuda/streams.html#Stream.query"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch.cuda.Stream.query" title="Permalink to this definition">¶</a></dt>
+<dd><p>Checks if all the work submitted has been completed.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>A boolean indicating if all kernels in this stream are completed.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="torch.cuda.Stream.record_event">
+<span class="sig-name descname"><span class="pre">record_event</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/torch/cuda/streams.html#Stream.record_event"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch.cuda.Stream.record_event" title="Permalink to this definition">¶</a></dt>
+<dd><p>Records an event.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>event</strong> (<a class="reference internal" href="torch.cuda.Event.html#torch.cuda.Event" title="torch.cuda.Event"><em>torch.cuda.Event</em></a><em>, </em><em>optional</em>) – event to record. If not given, a new one
+will be allocated.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>Recorded event.</p>
 </dd>
 </dl>
-<p>..Note:: In eager mode stream is of type Stream class while in JIT it is
-an object of the custom class <code class="docutils literal notranslate"><span class="pre">torch.classes.cuda.Stream</span></code>.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="torch.cuda.Stream.synchronize">
+<span class="sig-name descname"><span class="pre">synchronize</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/torch/cuda/streams.html#Stream.synchronize"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch.cuda.Stream.synchronize" title="Permalink to this definition">¶</a></dt>
+<dd><p>Wait for all the kernels in this stream to complete.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>This is a wrapper around <code class="docutils literal notranslate"><span class="pre">cudaStreamSynchronize()</span></code>: see
+<a class="reference external" href="https://docs.nvidia.com/cuda/cuda-runtime-api/group__CUDART__STREAM.html">CUDA Stream documentation</a> for more info.</p>
+</div>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="torch.cuda.Stream.wait_event">
+<span class="sig-name descname"><span class="pre">wait_event</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/torch/cuda/streams.html#Stream.wait_event"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch.cuda.Stream.wait_event" title="Permalink to this definition">¶</a></dt>
+<dd><p>Makes all future work submitted to the stream wait for an event.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>event</strong> (<a class="reference internal" href="torch.cuda.Event.html#torch.cuda.Event" title="torch.cuda.Event"><em>torch.cuda.Event</em></a>) – an event to wait for.</p>
+</dd>
+</dl>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>This is a wrapper around <code class="docutils literal notranslate"><span class="pre">cudaStreamWaitEvent()</span></code>: see
+<a class="reference external" href="https://docs.nvidia.com/cuda/cuda-runtime-api/group__CUDART__STREAM.html">CUDA Stream documentation</a> for more info.</p>
+<p>This function returns without waiting for <code class="xref py py-attr docutils literal notranslate"><span class="pre">event</span></code>: only future
+operations are affected.</p>
+</div>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="torch.cuda.Stream.wait_stream">
+<span class="sig-name descname"><span class="pre">wait_stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stream</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/torch/cuda/streams.html#Stream.wait_stream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch.cuda.Stream.wait_stream" title="Permalink to this definition">¶</a></dt>
+<dd><p>Synchronizes with another stream.</p>
+<p>All future work submitted to this stream will wait until all kernels
+submitted to a given stream at the time of call complete.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>stream</strong> (<a class="reference internal" href="#torch.cuda.Stream" title="torch.cuda.Stream"><em>Stream</em></a>) – a stream to synchronize.</p>
+</dd>
+</dl>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>This function returns without waiting for currently enqueued
+kernels in <a class="reference internal" href="torch.cuda.stream.html#torch.cuda.stream" title="torch.cuda.stream"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stream</span></code></a>: only future operations are affected.</p>
+</div>
+</dd></dl>
+
 </dd></dl>
 
 </section>
@@ -456,10 +540,10 @@ <h1>torch.cuda.stream<a class="headerlink" href="#torch-cuda-stream" title="Perm
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="torch.cuda.synchronize.html" class="btn btn-neutral float-right" title="torch.cuda.synchronize" accesskey="n" rel="next">Next <img src="../_static/images/chevron-right-orange.svg" class="next-page"></a>
+        <a href="torch.cuda.ExternalStream.html" class="btn btn-neutral float-right" title="ExternalStream" accesskey="n" rel="next">Next <img src="../_static/images/chevron-right-orange.svg" class="next-page"></a>
       
       
-        <a href="torch.cuda.set_sync_debug_mode.html" class="btn btn-neutral" title="torch.cuda.set_sync_debug_mode" accesskey="p" rel="prev"><img src="../_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+        <a href="torch.cuda.comm.gather.html" class="btn btn-neutral" title="torch.cuda.comm.gather" accesskey="p" rel="prev"><img src="../_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
       
     </div>
   
@@ -491,7 +575,7 @@ <h1>torch.cuda.stream<a class="headerlink" href="#torch-cuda-stream" title="Perm
           <div class="pytorch-right-menu" id="pytorch-right-menu">
             <div class="pytorch-side-scroll" id="pytorch-side-scroll-right">
               <ul>
-<li><a class="reference internal" href="#">torch.cuda.stream</a></li>
+<li><a class="reference internal" href="#">Stream</a></li>
 </ul>
 
             </div>
diff --git a/docs/master/generated/torch.nn.utils.prune.identity.html b/docs/master/generated/torch.nn.utils.prune.identity.html
index 3d10f9a53a9b..17b93a44594a 100644
--- a/docs/master/generated/torch.nn.utils.prune.identity.html
+++ b/docs/master/generated/torch.nn.utils.prune.identity.html
@@ -10,14 +10,14 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>torch.nn.utils.prune.identity &mdash; PyTorch master documentation</title>
+  <title>Identity &mdash; PyTorch master documentation</title>
   
 
   
   
   
   
-    <link rel="canonical" href="https://pytorch.org/docs/stable/generated/torch.nn.utils.prune.identity.html"/>
+    <link rel="canonical" href="https://pytorch.org/docs/stable/generated/torch.nn.utils.prune.Identity.html"/>
   
 
   
@@ -41,8 +41,8 @@
   <link rel="stylesheet" href="../_static/css/jit.css" type="text/css" />
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="torch.nn.utils.prune.random_unstructured" href="torch.nn.utils.prune.random_unstructured.html" />
-    <link rel="prev" title="CustomFromMask" href="torch.nn.utils.prune.CustomFromMask.html" />
+    <link rel="next" title="RandomUnstructured" href="torch.nn.utils.prune.RandomUnstructured.html" />
+    <link rel="prev" title="PruningContainer" href="torch.nn.utils.prune.PruningContainer.html" />
 
 <!--
   Search engines should not index the master version of documentation.
@@ -242,7 +242,7 @@
           
 
 <div>
-  <a style="color:#F05732" href="https://pytorch.org/docs/stable/generated/torch.nn.utils.prune.identity.html">
+  <a style="color:#F05732" href="https://pytorch.org/docs/stable/generated/torch.nn.utils.prune.Identity.html">
     You are viewing unstable developer preview docs.
     Click here to view docs for latest stable release.
   </a>
@@ -397,13 +397,13 @@
         
           <li><a href="../nn.html">torch.nn</a> &gt;</li>
         
-      <li>torch.nn.utils.prune.identity</li>
+      <li>Identity</li>
     
     
       <li class="pytorch-breadcrumbs-aside">
         
             
-            <a href="../_sources/generated/torch.nn.utils.prune.identity.rst.txt" rel="nofollow"><img src="../_static/images/view-page-source-icon.svg"></a>
+            <a href="../_sources/generated/torch.nn.utils.prune.Identity.rst.txt" rel="nofollow"><img src="../_static/images/view-page-source-icon.svg"></a>
           
         
       </li>
@@ -429,49 +429,92 @@
             <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
              <article itemprop="articleBody" id="pytorch-article" class="pytorch-article">
               
-  <section id="torch-nn-utils-prune-identity">
-<h1>torch.nn.utils.prune.identity<a class="headerlink" href="#torch-nn-utils-prune-identity" title="Permalink to this heading">¶</a></h1>
-<dl class="py function">
-<dt class="sig sig-object py" id="torch.nn.utils.prune.identity">
-<span class="sig-prename descclassname"><span class="pre">torch.nn.utils.prune.</span></span><span class="sig-name descname"><span class="pre">identity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/torch/nn/utils/prune.html#identity"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch.nn.utils.prune.identity" title="Permalink to this definition">¶</a></dt>
-<dd><p>Applies pruning reparametrization to the tensor corresponding to the
-parameter called <code class="docutils literal notranslate"><span class="pre">name</span></code> in <code class="docutils literal notranslate"><span class="pre">module</span></code> without actually pruning any
-units. Modifies module in place (and also return the modified module)
-by:</p>
-<ol class="arabic simple">
-<li><p>adding a named buffer called <code class="docutils literal notranslate"><span class="pre">name+'_mask'</span></code> corresponding to the
-binary mask applied to the parameter <code class="docutils literal notranslate"><span class="pre">name</span></code> by the pruning method.</p></li>
-<li><p>replacing the parameter <code class="docutils literal notranslate"><span class="pre">name</span></code> by its pruned version, while the
-original (unpruned) parameter is stored in a new parameter named
-<code class="docutils literal notranslate"><span class="pre">name+'_orig'</span></code>.</p></li>
-</ol>
-<div class="admonition note">
-<p class="admonition-title">Note</p>
-<p>The mask is a tensor of ones.</p>
-</div>
+  <section id="identity">
+<h1>Identity<a class="headerlink" href="#identity" title="Permalink to this heading">¶</a></h1>
+<dl class="py class">
+<dt class="sig sig-object py" id="torch.nn.utils.prune.Identity">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">torch.nn.utils.prune.</span></span><span class="sig-name descname"><span class="pre">Identity</span></span><a class="reference internal" href="../_modules/torch/nn/utils/prune.html#Identity"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch.nn.utils.prune.Identity" title="Permalink to this definition">¶</a></dt>
+<dd><p>Utility pruning method that does not prune any units but generates the
+pruning parametrization with a mask of ones.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="torch.nn.utils.prune.Identity.apply">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/torch/nn/utils/prune.html#Identity.apply"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch.nn.utils.prune.Identity.apply" title="Permalink to this definition">¶</a></dt>
+<dd><p>Adds the forward pre-hook that enables pruning on the fly and
+the reparametrization of a tensor in terms of the original tensor
+and the pruning mask.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>module</strong> (<a class="reference internal" href="torch.nn.Module.html#torch.nn.Module" title="torch.nn.Module"><em>nn.Module</em></a>) – module containing the tensor to prune.</p></li>
+<li><p><strong>module</strong> (<a class="reference internal" href="torch.nn.Module.html#torch.nn.Module" title="torch.nn.Module"><em>nn.Module</em></a>) – module containing the tensor to prune</p></li>
 <li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – parameter name within <code class="docutils literal notranslate"><span class="pre">module</span></code> on which pruning
 will act.</p></li>
 </ul>
 </dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="torch.nn.utils.prune.Identity.apply_mask">
+<span class="sig-name descname"><span class="pre">apply_mask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#torch.nn.utils.prune.Identity.apply_mask" title="Permalink to this definition">¶</a></dt>
+<dd><p>Simply handles the multiplication between the parameter being
+pruned and the generated mask.
+Fetches the mask and the original tensor from the module
+and returns the pruned version of the tensor.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>module</strong> (<a class="reference internal" href="torch.nn.Module.html#torch.nn.Module" title="torch.nn.Module"><em>nn.Module</em></a>) – module containing the tensor to prune</p>
+</dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>modified (i.e. pruned) version of the input module</p>
+<dd class="field-even"><p>pruned version of the input tensor</p>
 </dd>
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p>module (<a class="reference internal" href="torch.nn.Module.html#torch.nn.Module" title="torch.nn.Module">nn.Module</a>)</p>
+<dd class="field-odd"><p>pruned_tensor (<a class="reference internal" href="../tensors.html#torch.Tensor" title="torch.Tensor">torch.Tensor</a>)</p>
 </dd>
 </dl>
-<p class="rubric">Examples</p>
-<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">m</span> <span class="o">=</span> <span class="n">prune</span><span class="o">.</span><span class="n">identity</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">),</span> <span class="s1">&#39;bias&#39;</span><span class="p">)</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">bias_mask</span><span class="p">)</span>
-<span class="go">tensor([1., 1., 1.])</span>
-</pre></div>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="torch.nn.utils.prune.Identity.prune">
+<span class="sig-name descname"><span class="pre">prune</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_mask</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">importance_scores</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#torch.nn.utils.prune.Identity.prune" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computes and returns a pruned version of input tensor <code class="docutils literal notranslate"><span class="pre">t</span></code>
+according to the pruning rule specified in <code class="xref py py-meth docutils literal notranslate"><span class="pre">compute_mask()</span></code>.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>t</strong> (<a class="reference internal" href="../tensors.html#torch.Tensor" title="torch.Tensor"><em>torch.Tensor</em></a>) – tensor to prune (of same dimensions as
+<code class="docutils literal notranslate"><span class="pre">default_mask</span></code>).</p></li>
+<li><p><strong>importance_scores</strong> (<a class="reference internal" href="../tensors.html#torch.Tensor" title="torch.Tensor"><em>torch.Tensor</em></a>) – tensor of importance scores (of
+same shape as <code class="docutils literal notranslate"><span class="pre">t</span></code>) used to compute mask for pruning <code class="docutils literal notranslate"><span class="pre">t</span></code>.
+The values in this tensor indicate the importance of the
+corresponding elements in the <code class="docutils literal notranslate"><span class="pre">t</span></code> that is being pruned.
+If unspecified or None, the tensor <code class="docutils literal notranslate"><span class="pre">t</span></code> will be used in its place.</p></li>
+<li><p><strong>default_mask</strong> (<a class="reference internal" href="../tensors.html#torch.Tensor" title="torch.Tensor"><em>torch.Tensor</em></a><em>, </em><em>optional</em>) – mask from previous pruning
+iteration, if any. To be considered when determining what
+portion of the tensor that pruning should act on. If None,
+default to a mask of ones.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>pruned version of tensor <code class="docutils literal notranslate"><span class="pre">t</span></code>.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="torch.nn.utils.prune.Identity.remove">
+<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#torch.nn.utils.prune.Identity.remove" title="Permalink to this definition">¶</a></dt>
+<dd><p>Removes the pruning reparameterization from a module. The pruned
+parameter named <code class="docutils literal notranslate"><span class="pre">name</span></code> remains permanently pruned, and the parameter
+named <code class="docutils literal notranslate"><span class="pre">name+'_orig'</span></code> is removed from the parameter list. Similarly,
+the buffer named <code class="docutils literal notranslate"><span class="pre">name+'_mask'</span></code> is removed from the buffers.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Pruning itself is NOT undone or reversed!</p>
 </div>
 </dd></dl>
 
+</dd></dl>
+
 </section>
 
 
@@ -482,10 +525,10 @@ <h1>torch.nn.utils.prune.identity<a class="headerlink" href="#torch-nn-utils-pru
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="torch.nn.utils.prune.random_unstructured.html" class="btn btn-neutral float-right" title="torch.nn.utils.prune.random_unstructured" accesskey="n" rel="next">Next <img src="../_static/images/chevron-right-orange.svg" class="next-page"></a>
+        <a href="torch.nn.utils.prune.RandomUnstructured.html" class="btn btn-neutral float-right" title="RandomUnstructured" accesskey="n" rel="next">Next <img src="../_static/images/chevron-right-orange.svg" class="next-page"></a>
       
       
-        <a href="torch.nn.utils.prune.CustomFromMask.html" class="btn btn-neutral" title="CustomFromMask" accesskey="p" rel="prev"><img src="../_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+        <a href="torch.nn.utils.prune.PruningContainer.html" class="btn btn-neutral" title="PruningContainer" accesskey="p" rel="prev"><img src="../_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
       
     </div>
   
@@ -517,7 +560,7 @@ <h1>torch.nn.utils.prune.identity<a class="headerlink" href="#torch-nn-utils-pru
           <div class="pytorch-right-menu" id="pytorch-right-menu">
             <div class="pytorch-side-scroll" id="pytorch-side-scroll-right">
               <ul>
-<li><a class="reference internal" href="#">torch.nn.utils.prune.identity</a></li>
+<li><a class="reference internal" href="#">Identity</a></li>
 </ul>
 
             </div>

From 33d753db1329da495efc03e76240d96121c127ee Mon Sep 17 00:00:00 2001
From: Rita Iglesias <ritaiglesias@fb.com>
Date: Tue, 28 Jun 2022 17:49:26 -0300
Subject: [PATCH 2/3] Updating homepage ticker for 1.12 release

---
 _news/news-item-1.md | 4 ++--
 _news/news-item-2.md | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/_news/news-item-1.md b/_news/news-item-1.md
index 2f4e0c6779ac..b0c12f4c14d3 100644
--- a/_news/news-item-1.md
+++ b/_news/news-item-1.md
@@ -1,5 +1,5 @@
 ---
 order: 1
-link: https://pytorch.org/blog/pytorch-1.11-released
-summary: NEW! PyTorch 1.11, TorchData, and functorch are now available
+link: https://pytorch.org/blog/pytorch-1.12-released/
+summary: "New release! PyTorch 1.12: TorchArrow, Functional API for Modules and nvFuser are now available!"
 ---
diff --git a/_news/news-item-2.md b/_news/news-item-2.md
index f775ccb72d5f..fdcc73b0e9b2 100644
--- a/_news/news-item-2.md
+++ b/_news/news-item-2.md
@@ -1,5 +1,5 @@
 ---
 order: 2
-link: https://pytorch.org/blog/pytorch-1.11-new-library-releases
-summary: NEW! Introducing TorchRec, and other domain library updates in PyTorch 1.11
+link: https://pytorch.org/blog/pytorch-1.12-new-library-releases/
+summary: New libraries updates in PyTorch 1.12
 ---

From b15b260ede3e69fd447d42baa0b17d2ab36e8f8e Mon Sep 17 00:00:00 2001
From: Rita Iglesias <ritaiglesias@fb.com>
Date: Tue, 28 Jun 2022 18:25:48 -0300
Subject: [PATCH 3/3] Deleting 3rd new

---
 _news/news-item-3.md | 5 -----
 1 file changed, 5 deletions(-)
 delete mode 100644 _news/news-item-3.md

diff --git a/_news/news-item-3.md b/_news/news-item-3.md
deleted file mode 100644
index 83e6940bd654..000000000000
--- a/_news/news-item-3.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-order: 3
-link: https://pytorch.org/blog/introducing-torchrec
-summary: NEW! Introducing TorchRec, a library for modern production recommendation systems
----