Fix up docs for neptune-query (#397)

* fix Filter docstring

* fix typo

* add note of Runs API

Author: normandy7

README-neptune-query.md

@@ -43,6 +43,14 @@ Available functions:
 - `list_experiments()` – names of experiments in the target project.
 - `set_api_token()` – set the Neptune API token to use for the session.
 
+> To use the corresponding methods for runs, import the Runs API:
+>
+> ```python
+> import neptune_query.runs as nq_runs
+> ```
+>
+> You can use these methods to target individual runs by ID instead of experiment runs by name.
+
 ### Example 1: Fetch metric values
 
 To fetch values at each step, use `fetch_metrics()`.

src/neptune_query/__init__.py

@@ -378,7 +378,7 @@ def download_files(
 
     - For file series, use `fetch_series()` to specify the content containing the files
     and pass the output to the `files` argument.
-    - For invdividually assigned files, use `fetch_experiments_table()`.
+    - For individually assigned files, use `fetch_experiments_table()`.
 
     Args:
         project: Path of the Neptune project, as `WorkspaceName/ProjectName`.

src/neptune_query/filters.py

@@ -214,22 +214,25 @@ def __str__(self) -> str:
 class Filter:
     """Specifies criteria for experiments or attributes when using a fetching method.
 
+    For regular expressions, the extended syntax is supported.
+    For details, see https://docs.neptune.ai/regex/#compound-expressions
+
     Examples of filters:
-        - Name or attribute value must match regular expression.
+        - Name or attribute value must match a regex.
         - Attribute value must pass a condition, like "greater than 0.9".
         - Attribute of a given name must exist.
 
     You can negate a filter or join multiple filters with logical operators.
 
     Methods available for attribute values:
-        - `name()`: Experiment name matches an extended regular expression or a list of names
+        - `name()`: Experiment name matches a regex or a list of names
         - `eq()`: Attribute value equals
         - `ne()`: Attribute value doesn't equal
         - `gt()`: Attribute value is greater than
         - `ge()`: Attribute value is greater than or equal to
         - `lt()`: Attribute value is less than
         - `le()`: Attribute value is less than or equal to
-        - `matches()`: Experiment name matches an extended regular expression
+        - `matches()`: String attribute value matches a regex
         - `contains_all()`: Tagset contains all tags, or string contains substrings
         - `contains_none()`: Tagset doesn't contain any of the tags, or string doesn't contain the substrings
         - `exists()`: Attribute exists

src/neptune_query/runs.py

@@ -367,7 +367,7 @@ def download_files(
 
     - For file series, use `fetch_series()` to specify the content containing the files
     and pass the output to the `files` argument.
-    - For invdividually assigned files, use `fetch_runs_table()`.
+    - For individually assigned files, use `fetch_runs_table()`.
 
     Args:
         project: Path of the Neptune project, as `WorkspaceName/ProjectName`.