[Doc] Missing headers (pytorch#796)

* init * missing headers * amend * amend * amend
ai4co · Jan 5, 2023 · 80d4317 · 80d4317
1 parent f56bdc5
commit 80d4317
Show file tree

Hide file tree

Showing 25 changed files with 104 additions and 13 deletions.
diff --git a/benchmarks/storage/benchmark_sample_latency_over_rpc.py b/benchmarks/storage/benchmark_sample_latency_over_rpc.py
@@ -1,3 +1,8 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 """
 Sample latency benchmarking (using RPC)
 ======================================

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -27,9 +27,11 @@ for :doc:`cost functions <reference/objectives>`, :ref:`returns <reference/objec
 
 TorchRL aims at a high modularity and good runtime performance.
 
+Tutorials
+=========
+
 .. toctree::
    :maxdepth: 2
-   :caption: Tutorials:
 
    tutorials/torchrl_demo
    tutorials/tensordict_tutorial
@@ -39,9 +41,11 @@ TorchRL aims at a high modularity and good runtime performance.
    tutorials/coding_ddpg
    tutorials/coding_dqn
 
+References
+==========
+
 .. toctree::
    :maxdepth: 3
-   :caption: References:
 
    reference/index
    reference/knowledge_base

diff --git a/docs/source/reference/modules.rst b/docs/source/reference/modules.rst
@@ -27,8 +27,8 @@ TensorDict modules
     SafeProbabilisticSequential
     SafeSequential
     WorldModelWrapper
-    tensordict_module.common.is_tensordict_compatible
-    tensordict_module.common.ensure_tensordict_compatible
+    common.is_tensordict_compatible
+    common.ensure_tensordict_compatible
 
 Hooks
 -----

diff --git a/docs/source/reference/trainers.rst b/docs/source/reference/trainers.rst
@@ -204,3 +204,5 @@ Loggers
     MLFlowLogger
     TensorboardLogger
     WandbLogger
+    get_logger
+    generate_exp_name
diff --git a/test/opengl_rendering.py b/test/opengl_rendering.py
@@ -1,3 +1,8 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 """Headless GPU-accelerated OpenGL context creation on Google Colaboratory.
 Typical usage:
     # Optional PyOpenGL configuratiopn can be done here.

diff --git a/test/smoke_test.py b/test/smoke_test.py
@@ -1,3 +1,9 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
+
 def test_imports():
     from torchrl.data import (
         PrioritizedReplayBuffer,

diff --git a/test/smoke_test_deps.py b/test/smoke_test_deps.py
@@ -1,3 +1,8 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 import argparse
 import tempfile
 

diff --git a/test/test_actors.py b/test/test_actors.py
@@ -1,3 +1,8 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 import pytest
 import torch
 from torchrl.modules.tensordict_module.actors import (

diff --git a/test/test_loggers.py b/test/test_loggers.py
@@ -1,3 +1,8 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 import argparse
 import os
 import os.path

diff --git a/test/test_rb_distributed.py b/test/test_rb_distributed.py
@@ -1,3 +1,8 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 import os
 import time
 

diff --git a/torchrl/data/replay_buffers/rb_prototype.py b/torchrl/data/replay_buffers/rb_prototype.py
@@ -1,3 +1,8 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 import collections
 import threading
 from concurrent.futures import ThreadPoolExecutor

diff --git a/torchrl/data/replay_buffers/samplers.py b/torchrl/data/replay_buffers/samplers.py
@@ -1,3 +1,8 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 from abc import ABC, abstractmethod
 from typing import Any, Tuple, Union
 

diff --git a/torchrl/data/replay_buffers/writers.py b/torchrl/data/replay_buffers/writers.py
@@ -1,3 +1,8 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 from abc import ABC, abstractmethod
 from typing import Any, Sequence
 

diff --git a/torchrl/envs/libs/brax.py b/torchrl/envs/libs/brax.py
@@ -1,3 +1,8 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 from typing import Dict, Optional, Union
 
 import torch

diff --git a/torchrl/envs/libs/habitat.py b/torchrl/envs/libs/habitat.py
@@ -1,3 +1,8 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 from torchrl.envs.libs.gym import GymEnv
 
 try:

diff --git a/torchrl/envs/libs/jax_utils.py b/torchrl/envs/libs/jax_utils.py
@@ -1,3 +1,8 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 import dataclasses
 from typing import Union
 

diff --git a/torchrl/envs/libs/jumanji.py b/torchrl/envs/libs/jumanji.py
@@ -1,3 +1,8 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 from typing import Dict, Optional, Union
 
 import numpy as np

diff --git a/torchrl/modules/__init__.py b/torchrl/modules/__init__.py
@@ -52,4 +52,4 @@
     ValueOperator,
     WorldModelWrapper,
 )
-from .planners import CEMPlanner, MPCPlannerBase  # usort:skip
+from .planners import CEMPlanner, MPCPlannerBase, MPPIPlanner  # usort:skip
diff --git a/torchrl/objectives/__init__.py b/torchrl/objectives/__init__.py
@@ -10,6 +10,7 @@
 from .dreamer import DreamerActorLoss, DreamerModelLoss, DreamerValueLoss
 from .ppo import ClipPPOLoss, KLPENPPOLoss, PPOLoss
 from .redq import REDQLoss
+from .reinforce import ReinforceLoss
 from .sac import SACLoss
 from .utils import (
     distance_loss,

diff --git a/torchrl/objectives/deprecated.py b/torchrl/objectives/deprecated.py
@@ -1,3 +1,8 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 import math
 from numbers import Number
 from typing import Tuple, Union

diff --git a/torchrl/objectives/reinforce.py b/torchrl/objectives/reinforce.py
@@ -1,11 +1,16 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
 from typing import Optional
 
 import torch
 from tensordict.tensordict import TensorDict, TensorDictBase
 
-from torchrl.modules import SafeModule, SafeProbabilisticSequential
-from torchrl.objectives import distance_loss
+from torchrl.modules.tensordict_module import SafeModule, SafeProbabilisticSequential
 from torchrl.objectives.common import LossModule
+from torchrl.objectives.utils import distance_loss
 
 
 class ReinforceLoss(LossModule):

diff --git a/torchrl/trainers/__init__.py b/torchrl/trainers/__init__.py
@@ -18,5 +18,3 @@
     Trainer,
     UpdateWeights,
 )
-
-# from .loggers import *
diff --git a/torchrl/trainers/loggers/__init__.py b/torchrl/trainers/loggers/__init__.py
@@ -7,4 +7,5 @@
 from .csv import CSVLogger
 from .mlflow import MLFlowLogger
 from .tensorboard import TensorboardLogger
+from .utils import generate_exp_name, get_logger
 from .wandb import WandbLogger
diff --git a/torchrl/trainers/loggers/utils.py b/torchrl/trainers/loggers/utils.py
@@ -1,3 +1,9 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
+
 import os
 import pathlib
 import uuid

diff --git a/tutorials/sphinx-tutorials/README.rst b/tutorials/sphinx-tutorials/README.rst
@@ -1,4 +1,2 @@
-README Demos
-================
-
-Below are examples using my module:
+README Tutos
+============