[DOC] Small improvements

2021-05-21 15:59:44 +02:00
parent e3f8828da4
commit 14508f0600
2 changed files with 7 additions and 0 deletions
--- a/prototorch/datasets/spiral.py
+++ b/prototorch/datasets/spiral.py
@@ -5,6 +5,10 @@ import torch


 def make_spiral(n_samples=500, noise=0.3):
+    """Generates the Spiral Dataset.
+    
+    For use in Prototorch use `prototorch.datasets.Spiral` instead.
+    """
    def get_samples(n, delta_t):
        points = []
        for i in range(n):