updated go-to experiment (#58)

* updated docstrings and examples
neptune-ai · Oct 4, 2019 · 0e1b50c · 0e1b50c
1 parent 0a697fd
commit 0e1b50c
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 6 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -49,7 +49,7 @@
 # The short X.Y version
 version = '0.13'
 # The full version, including alpha/beta/rc tags
-release = '0.13.3'
+release = '0.13.4'
 
 # -- General configuration ---------------------------------------------------
 

diff --git a/docs/examples/observer_sacred.ipynb b/docs/examples/observer_sacred.ipynb
@@ -79,7 +79,7 @@
     "## Go to Neptune app and observe your experiment\n",
     "Now you can watch your Sacred model training in neptune!\n",
     "\n",
-    "For example, you can check [this experiment](https://ui.neptune.ml/jakub-czakon/examples/e/EX-263)\n",
+    "For example, you can check [this experiment](https://ui.neptune.ml/jakub-czakon/examples/e/EX-341)\n",
     "        \n",
     "![image](https://gist.githubusercontent.com/jakubczakon/f754769a39ea6b8fa9728ede49b9165c/raw/ae86f7321113327602be89c6ed3ac9d618ffdb4c/sacred_observer.png)"
    ]

diff --git a/neptunecontrib/monitoring/sacred.py b/neptunecontrib/monitoring/sacred.py
@@ -32,9 +32,11 @@ class NeptuneObserver(RunObserver):
         project_name(str): project name in Neptune app
         api_token(str): Neptune API token. If it is kept in the NEPTUNE_API_TOKEN environment
            variable leave None here.
-        base_dir(str): base directory from which you run your code.
         source_extensions(list(str)): list of extensions that Neptune should treat as source files
-           extensions and send.
+           extensions and send. If None is passed, Python file from which experiment was created will be uploaded.
+           Pass empty list ([]) to upload no files. Unix style pathname pattern expansion is supported.
+           For example, you can pass '*.py' to upload all python source files from the current directory.
+           For recursion lookup use '**/*.py' (for Python 3.5 and later). For more information see glob library.
 
     Examples:
         Create sacred experiment::
@@ -70,7 +72,7 @@ def run(C, gamma, _run):
                 return clf.score(iris.data[90:],
                                  iris.target[90:])
 
-        Go to the app and see the experiment. For example, https://ui.neptune.ml/jakub-czakon/examples/e/EX-263
+        Go to the app and see the experiment. For example, https://ui.neptune.ml/jakub-czakon/examples/e/EX-341
     """
 
     def __init__(self, project_name, api_token=None, source_extensions=None):

diff --git a/setup.py b/setup.py
@@ -20,7 +20,7 @@ def main():
 
     setup(
         name='neptune-contrib',
-        version='0.13.3',
+        version='0.13.4',
         description='Neptune Python library contributions',
         author='neptune.ml',
         author_email='[email protected]',