docs

Lightning-AI · Dec 13, 2020 · 65263b3 · 65263b3
1 parent 7195330
commit 65263b3
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 8 deletions.
diff --git a/docs/source/amp.rst b/docs/source/amp.rst
@@ -31,7 +31,7 @@ Native torch
 When using PyTorch 1.6+ Lightning uses the native amp implementation to support 16-bit.
 
 .. testcode::
-    :skipif: not APEX_AVAILABLE and not NATIVE_AMP_AVAILABLE
+    :skipif: not _APEX_AVAILABLE and not _NATIVE_AMP_AVAILABLE
 
     # turn on 16-bit
     trainer = Trainer(precision=16)
@@ -73,7 +73,7 @@ Enable 16-bit
 ^^^^^^^^^^^^^
 
 .. testcode::
-    :skipif: not APEX_AVAILABLE and not NATIVE_AMP_AVAILABLE
+    :skipif: not _APEX_AVAILABLE and not _NATIVE_AMP_AVAILABLE
 
     # turn on 16-bit
     trainer = Trainer(amp_level='O2', precision=16)
@@ -88,7 +88,7 @@ TPU 16-bit
 16-bit on TPUs is much simpler. To use 16-bit with TPUs set precision to 16 when using the TPU flag
 
 .. testcode::
-    :skipif: not TPU_AVAILABLE
+    :skipif: not _TPU_AVAILABLE
 
     # DEFAULT
     trainer = Trainer(tpu_cores=8, precision=32)

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -364,7 +364,7 @@ def package_list_from_file(file):
     _XLA_AVAILABLE,
     _TPU_AVAILABLE,
 )
-TORCHVISION_AVAILABLE = importlib.util.find_spec("torchvision") is not None
+_TORCHVISION_AVAILABLE = importlib.util.find_spec("torchvision") is not None
 
 
 """

diff --git a/docs/source/introduction_guide.rst b/docs/source/introduction_guide.rst
@@ -135,7 +135,7 @@ Data
 Lightning operates on pure dataloaders. Here's the PyTorch code for loading MNIST.
 
 .. testcode::
-    :skipif: not TORCHVISION_AVAILABLE
+    :skipif: not _TORCHVISION_AVAILABLE
 
     from torch.utils.data import DataLoader, random_split
     from torchvision.datasets import MNIST
@@ -153,7 +153,7 @@ Lightning operates on pure dataloaders. Here's the PyTorch code for loading MNIS
 
 .. testoutput::
     :hide:
-    :skipif: os.path.isdir(os.path.join(os.getcwd(), 'MNIST')) or not TORCHVISION_AVAILABLE
+    :skipif: os.path.isdir(os.path.join(os.getcwd(), 'MNIST')) or not _TORCHVISION_AVAILABLE
 
     Downloading ...
     Extracting ...

diff --git a/docs/source/trainer.rst b/docs/source/trainer.rst
@@ -1180,7 +1180,7 @@ If used on TPU will use torch.bfloat16 but tensor printing
 will still show torch.float32.
 
 .. testcode::
-    :skipif: not APEX_AVAILABLE and not NATIVE_AMP_AVAILABLE
+    :skipif: not _APEX_AVAILABLE and not _NATIVE_AMP_AVAILABLE
 
     # default used by the Trainer
     trainer = Trainer(precision=32)

diff --git a/docs/source/transfer_learning.rst b/docs/source/transfer_learning.rst
@@ -46,7 +46,7 @@ Example: Imagenet (computer Vision)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. testcode::
-    :skipif: not TORCHVISION_AVAILABLE
+    :skipif: not _TORCHVISION_AVAILABLE
 
     import torchvision.models as models