Skip to content

Commit

Permalink
auto-generating sphinx docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pytorchbot committed Jan 1, 2025
1 parent a232193 commit 98d272c
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion main/_modules/torchtune/datasets/_sft.html
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,7 @@ <h1>Source code for torchtune.datasets._sft</h1><div class="highlight"><pre>
<span class="sd"> ``load_dataset`` for more details.</span>
<span class="sd"> message_transform (Transform): callable that keys into the desired fields in the sample</span>
<span class="sd"> and converts text content to a list of :class:`~torchtune.data.Message`. It is expected that the final list</span>
<span class="sd"> of messages are stored in the ``&quot;messages&quot;`` key.</span>
<span class="sd"> of messages are stored in the ``&quot;messages&quot;`` key. See :ref:`message_transform_usage_label` for details.</span>
<span class="sd"> model_transform (Transform): callable that applies model-specific pre-processing to the sample after the list of</span>
<span class="sd"> messages is created from ``message_transform``. This includes tokenization and any modality-specific</span>
<span class="sd"> transforms. It is expected to return at minimum ``&quot;tokens&quot;`` and ``&quot;mask&quot;`` keys.</span>
Expand Down
2 changes: 1 addition & 1 deletion main/generated/torchtune.datasets.SFTDataset.html
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,7 @@ <h1>SFTDataset<a class="headerlink" href="#sftdataset" title="Permalink to this
<code class="docutils literal notranslate"><span class="pre">load_dataset</span></code> for more details.</p></li>
<li><p><strong>message_transform</strong> (<a class="reference internal" href="torchtune.modules.transforms.Transform.html#torchtune.modules.transforms.Transform" title="torchtune.modules.transforms.Transform"><em>Transform</em></a>) – callable that keys into the desired fields in the sample
and converts text content to a list of <a class="reference internal" href="torchtune.data.Message.html#torchtune.data.Message" title="torchtune.data.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a>. It is expected that the final list
of messages are stored in the <code class="docutils literal notranslate"><span class="pre">&quot;messages&quot;</span></code> key.</p></li>
of messages are stored in the <code class="docutils literal notranslate"><span class="pre">&quot;messages&quot;</span></code> key. See <a class="reference internal" href="../basics/message_transforms.html#message-transform-usage-label"><span class="std std-ref">Message Transforms</span></a> for details.</p></li>
<li><p><strong>model_transform</strong> (<a class="reference internal" href="torchtune.modules.transforms.Transform.html#torchtune.modules.transforms.Transform" title="torchtune.modules.transforms.Transform"><em>Transform</em></a>) – callable that applies model-specific pre-processing to the sample after the list of
messages is created from <code class="docutils literal notranslate"><span class="pre">message_transform</span></code>. This includes tokenization and any modality-specific
transforms. It is expected to return at minimum <code class="docutils literal notranslate"><span class="pre">&quot;tokens&quot;</span></code> and <code class="docutils literal notranslate"><span class="pre">&quot;mask&quot;</span></code> keys.</p></li>
Expand Down

0 comments on commit 98d272c

Please sign in to comment.