Skip to content

Commit c2a4a23

Browse files
committedJun 6, 2024
Bump version to 0.0.29 and update documentation [skip ci]
1 parent 115e04e commit c2a4a23

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed
 

‎docs/_build/html/RemotePathDataset.html

+7-5
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,16 @@ <h1>RemotePathDataset<a class="headerlink" href="#remotepathdataset" title="Link
7777
</ul>
7878
</dd>
7979
<dt class="field-even">Yields<span class="colon">:</span></dt>
80-
<dd class="field-even"><p><em>Tuple[torch.Tensor, Union[str, List[int]]]</em></p>
80+
<dd class="field-even"><p><em>tuple</em></p>
8181
<dl class="simple">
82-
<dt>A tuple containing the image as a tensor and the label as the remote path or class indices.</dt><dd><p>or</p>
83-
</dd>
84-
<dt>Tuple[torch.Tensor, Union[str, List[int]], str]: A tuple containing the image as a tensor, the label as the remote path or class indices, and the local or remote path.</dt><dd><p>or</p>
82+
<dt>A tuple containing the following elements:</dt><dd><ul class="simple">
83+
<li><p>torch.Tensor: The image as a tensor.</p></li>
84+
<li><p>Union[str, List[int]]: The label as the remote path or as a list of class indices.</p></li>
85+
<li><p>Optional[str]: The local path, if <cite>return_local_path</cite> is True.</p></li>
86+
<li><p>Optional[str]: The remote path, if <cite>return_remote_path</cite> is True.</p></li>
87+
</ul>
8588
</dd>
8689
</dl>
87-
<p>Tuple[torch.Tensor, Union[str, List[int]], str, str]: A tuple containing the image as a tensor, the label as the remote path or class indices, the local path, and the remote path.</p>
8890
</dd>
8991
</dl>
9092
</dd></dl>

0 commit comments

Comments
 (0)