Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove transitions from docs to comply with warnings from sphinx-check #491

Merged
merged 6 commits into from
Jan 3, 2021
Merged

Remove transitions from docs to comply with warnings from sphinx-check #491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6fb0921
Empty commit
akihironitta Jan 3, 2021
e11b5c9
Fix self_supervised_models.rst
akihironitta Jan 3, 2021
3f7004c
Fix losses.rst
akihironitta Jan 3, 2021
5a9c5f2
Fix transforms.rst
akihironitta Jan 3, 2021
1b9e1be
Fix vision_datamodules.rst
akihironitta Jan 3, 2021
cf95a86
Merge branch 'master' of github.com:PyTorchLightning/pytorch-lightnin…
akihironitta Jan 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions docs/source/losses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,12 @@ DQN Loss
.. autofunction:: pl_bolts.losses.rl.dqn_loss
:noindex:

---------------
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that @williamFalcon made it on purpose, so is there another way how to have a horizontal line?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I looked through the docs, but I'm still not sure if there's another way to draw a horizontal line...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could it be this one? https://docutils.sourceforge.io/docs/ref/doctree.html#transition
so let's just remove it at this moment :]


Double DQN Loss
---------------

.. autofunction:: pl_bolts.losses.rl.double_dqn_loss
:noindex:

---------------

Per DQN Loss
------------

Expand Down
10 changes: 0 additions & 10 deletions docs/source/self_supervised_models.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,16 +92,12 @@ AMDIM
.. autoclass:: pl_bolts.models.self_supervised.AMDIM
:noindex:

---------

BYOL
^^^^

.. autoclass:: pl_bolts.models.self_supervised.BYOL
:noindex:

---------

CPC (V2)
^^^^^^^^

Expand Down Expand Up @@ -253,16 +249,12 @@ CPCV2 API
.. autoclass:: pl_bolts.models.self_supervised.CPCV2
:noindex:

---------

Moco (V2)
^^^^^^^^^

.. autoclass:: pl_bolts.models.self_supervised.MocoV2
:noindex:

---------

SimCLR
^^^^^^

Expand Down Expand Up @@ -389,8 +381,6 @@ SimCLR API
.. autoclass:: pl_bolts.models.self_supervised.SimCLR
:noindex:

---------

SwAV
^^^^

Expand Down
6 changes: 0 additions & 6 deletions docs/source/transforms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,6 @@ STL-10 Eval (c)
.. autoclass:: pl_bolts.models.self_supervised.cpc.transforms.CPCEvalTransformsSTL10
:noindex:

-------------------

AMDIM transforms
----------------

Expand Down Expand Up @@ -82,8 +80,6 @@ STL-10 Eval (a)
.. autoclass:: pl_bolts.models.self_supervised.amdim.transforms.AMDIMEvalTransformsSTL10
:noindex:

---------------

MOCO V2 transforms
------------------

Expand Down Expand Up @@ -120,8 +116,6 @@ STL-10 Eval (m2)
.. autoclass:: pl_bolts.models.self_supervised.moco.transforms.Moco2EvalImagenetTransforms
:noindex:

---------------

SimCLR transforms
------------------
Transforms used for SimCLR
Expand Down
4 changes: 1 addition & 3 deletions docs/source/vision_datamodules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ MNIST
.. autoclass:: pl_bolts.datamodules.mnist_datamodule.MNISTDataModule
:noindex:

------------

Semi-supervised learning
------------------------
The following datasets have support for unlabeled training and semi-supervised learning where only a few examples
Expand All @@ -64,4 +62,4 @@ STL-10
^^^^^^

.. autoclass:: pl_bolts.datamodules.stl10_datamodule.STL10DataModule
:noindex:
:noindex: