Skip to content

Commit

Permalink
Update README.md (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
normandy7 authored Oct 26, 2023
1 parent 355e711 commit 12464c8
Showing 1 changed file with 38 additions and 3 deletions.
41 changes: 38 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,33 @@
# Utilities for using Neptune client on AWS
# Neptune-AWS integration

This integration exposes the `init_run()` function that reads the Neptune API token and project name from
AWS Secrets Manager instead of environment variables.
Read your Neptune credentials directly from AWS Secrets.

## What will you get with this integration?

* Log, organize, visualize, and compare ML experiments in a single place
* Monitor model training live
* Version and query production-ready models and associated metadata (e.g. datasets)
* Collaborate with the team and across the organization

## What will be logged to Neptune?

* Training code and Git information
* System metrics and hardware consumption
* [Other metadata](https://docs.neptune.ai/logging/what_you_can_log)

## Resources

* [Documentation](https://docs.neptune.ai/integrations/aws/)

## Example

Install Neptune and the integration:

```sh
pip install -U "neptune[aws]"
```

Enable Neptune logging:

```python
from neptune.integrations.aws import init_run
Expand All @@ -11,3 +37,12 @@ run = init_run(
region="us-west-1", # Use the appropriate region here
)
```

## Support

If you got stuck or simply want to talk to us, here are your options:

* Check our [FAQ page](https://docs.neptune.ai/getting_help).
* You can submit bug reports, feature requests, or contributions directly to the repository.
* Chat! In the Neptune app, click the blue message icon in the bottom-right corner and send a message. A real person will talk to you ASAP (typically very ASAP).
* You can just shoot us an email at [support@neptune.ai](mailto:support@neptune.ai).

0 comments on commit 12464c8

Please sign in to comment.