Skip to content

Commit b9a3de2

Browse files
authored
Update README.md for 1.4.1 (#54)
* Update README.md for 1.4.0 Updates the README for neptune-query release 1.4.0. Do not merge ahead of the release. * Update README.md
1 parent 1107096 commit b9a3de2

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ With the Query API, you can:
1111
## Installation
1212

1313
```bash
14-
pip install "neptune-query>=1.2.0,<2.0.0"
14+
pip install "neptune-query>=1.4.1,<2.0.0"
1515
```
1616

1717
Set your Neptune API token and project name as environment variables:
@@ -24,7 +24,7 @@ export NEPTUNE_API_TOKEN="ApiTokenFromYourNeptuneProfile"
2424
export NEPTUNE_PROJECT="workspace-name/project-name"
2525
```
2626

27-
For help, see [Get started][setup] in the Neptune documentation.
27+
For help, see [Query metadata: Setup][setup] in the Neptune documentation.
2828

2929
> **Note:** You can also pass the project path to the `project` argument of any querying function.
3030
@@ -42,6 +42,9 @@ Available functions:
4242
- `list_attributes()` &ndash; all logged attributes of the target project's experiment runs.
4343
- `list_experiments()` &ndash; names of experiments in the target project.
4444
- `set_api_token()` &ndash; set the Neptune API token to use for the session.
45+
- (experimental) `fetch_metric_buckets()` &ndash; get summary values split by X-axis buckets.
46+
47+
For details, see the [API reference][api-reference].
4548

4649
> To use the corresponding methods for runs, import the Runs API:
4750
>
@@ -95,14 +98,21 @@ exp_hstrj 0.365521 0.459901 0.01
9598

9699
> For series attributes, the value of the last logged step is returned.
97100
101+
## Documentation
102+
103+
- [How to query metadata][query-metadata]
104+
- [API reference][api-reference]
105+
98106
---
99107

100108
## License
101109

102110
This project is licensed under the Apache License Version 2.0. For details, see [Apache License Version 2.0][license].
103111

104112

105-
[setup]: https://docs.neptune.ai/setup
113+
[api-reference]: https://docs.neptune.ai/api_overview
114+
[query-metadata]: https://docs.neptune.ai/query_metadata
115+
[setup]: https://docs.neptune.ai/query_metadata#setup
106116

107117
[neptune-client-scale]: https://github.com/neptune-ai/neptune-client-scale
108118

0 commit comments

Comments
 (0)