Skip to content

Commit 95287aa

Browse files
authored
Fixed failing linkcheck CI job (#3010)
* Fixed failing linkcheck CI job * http -> https and add urls to ignore * fixed trailing whitespace * Removed accidental addition
1 parent a46903e commit 95287aa

6 files changed

Lines changed: 16 additions & 9 deletions

File tree

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ help:
1313
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1414

1515
docset: html
16-
doc2dash --name $(SPHINXPROJ) --icon $(SOURCEDIR)/_static/img/pytorch-logo-flame.png --enable-js --online-redirect-url http://pytorch.org/ignite/ --force $(BUILDDIR)/html/
16+
doc2dash --name $(SPHINXPROJ) --icon $(SOURCEDIR)/_static/img/pytorch-logo-flame.png --enable-js --online-redirect-url https://pytorch.org/ignite/ --force $(BUILDDIR)/html/
1717

1818
# Manually fix because Zeal doesn't deal well with `icon.png`-only at 2x resolution.
1919
cp $(SPHINXPROJ).docset/icon.png $(SPHINXPROJ).docset/[email protected]

docs/source/conf.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,6 +346,12 @@ def run(self):
346346
("py:class", "torch.utils.data.dataloader.DataLoader"),
347347
]
348348

349+
linkcheck_ignore = [
350+
"https://github.com/fossasia/visdom#visdom-arguments-python-only",
351+
"https://github.com/pytorch/ignite/tree/master/examples/contrib/cifar10#check-resume-training",
352+
"https://github.com/pytorch/ignite/tree/master/examples/mnist#training-save--resume",
353+
]
354+
349355

350356
def setup(app):
351357
app.add_directive("autosummary", AutolistAutosummary, override=True)

docs/source/engine.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ from iteration.
117117

118118
Complete examples that resumes the training from a checkpoint can be found here:
119119

120-
- `save/resume MNIST <https://github.com/pytorch/ignite/tree/master/examples/mnist#user-content-training-save--resume>`_
121-
- `save/resume Distributed CIFAR10 <https://github.com/pytorch/ignite/tree/master/examples/contrib/cifar10#user-content-check-resume-training>`_
120+
- `save/resume MNIST <https://github.com/pytorch/ignite/tree/master/examples/mnist#training-save--resume>`_
121+
- `save/resume Distributed CIFAR10 <https://github.com/pytorch/ignite/tree/master/examples/contrib/cifar10#check-resume-training>`_
122122

123123
Deterministic training
124124
----------------------
@@ -213,8 +213,8 @@ We can see that the data samples are exactly the same between original and resum
213213
Complete examples that simulates a crash on a defined iteration and resumes the training from a checkpoint can be found
214214
here:
215215

216-
- `save/resume MNIST <https://github.com/pytorch/ignite/tree/master/examples/mnist#user-content-training-save--resume>`_
217-
- `save/resume Distributed CIFAR10 <https://github.com/pytorch/ignite/tree/master/examples/contrib/cifar10#user-content-check-resume-training>`_
216+
- `save/resume MNIST <https://github.com/pytorch/ignite/tree/master/examples/mnist#training-save--resume>`_
217+
- `save/resume Distributed CIFAR10 <https://github.com/pytorch/ignite/tree/master/examples/contrib/cifar10#check-resume-training>`_
218218

219219

220220
.. Note ::

ignite/contrib/handlers/visdom_logger.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ class VisdomLogger(BaseLogger):
4343
visdom server. Default, `num_workers=1`. If `num_workers=0` and logger uses the main thread. If using
4444
Python 2.7 and `num_workers>0` the package `futures` should be installed: `pip install futures`
4545
kwargs: kwargs to pass into
46-
`visdom.Visdom <https://github.com/fossasia/visdom#user-content-visdom-arguments-python-only>`_.
46+
`visdom.Visdom <https://github.com/fossasia/visdom#visdom-arguments-python-only>`_.
4747
4848
Note:
4949
We can also specify username/password using environment variables: VISDOM_USERNAME, VISDOM_PASSWORD

ignite/distributed/auto.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ def auto_dataloader(dataset: Dataset, **kwargs: Any) -> Union[DataLoader, "_MpDe
5757
)
5858
5959
.. _torch DataLoader: https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader
60-
.. _XLA MpDeviceLoader: https://github.com/pytorch/xla/blob/master/torch_xla/distributed/parallel_loader.py#L178
60+
.. _XLA MpDeviceLoader:
61+
https://pytorch.org/xla/release/2.0/index.html#running-on-multiple-xla-devices-with-multi-processing
6162
.. _torch DistributedSampler:
6263
https://pytorch.org/docs/stable/data.html#torch.utils.data.distributed.DistributedSampler
6364
.. _torch IterableDataset: https://pytorch.org/docs/stable/data.html#torch.utils.data.IterableDataset
@@ -255,7 +256,7 @@ def auto_optim(optimizer: Optimizer, **kwargs: Any) -> Optimizer:
255256
256257
optimizer = idist.auto_optim(optimizer)
257258
258-
.. _xm.optimizer_step: http://pytorch.org/xla/release/1.5/index.html#torch_xla.core.xla_model.optimizer_step
259+
.. _xm.optimizer_step: https://pytorch.org/xla/release/1.5/index.html#torch_xla.core.xla_model.optimizer_step
259260
260261
.. versionchanged:: 0.4.2
261262
Added Horovod distributed optimizer.

ignite/distributed/utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ def train_fn(local_rank, a, b, c, d=12):
305305
306306
.. _dist.init_process_group: https://pytorch.org/docs/stable/distributed.html#torch.distributed.init_process_group
307307
.. _mp.start_processes: https://pytorch.org/docs/stable/multiprocessing.html#torch.multiprocessing.spawn
308-
.. _xmp.spawn: http://pytorch.org/xla/release/1.6/index.html#torch_xla.distributed.xla_multiprocessing.spawn
308+
.. _xmp.spawn: https://pytorch.org/xla/release/1.6/index.html#torch_xla.distributed.xla_multiprocessing.spawn
309309
.. _hvd_run: https://horovod.readthedocs.io/en/latest/api.html#module-horovod.run
310310
311311
.. versionchanged:: 0.4.2

0 commit comments

Comments
 (0)