Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create proper README #69

Merged
merged 3 commits into from
Oct 25, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 67 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,69 @@
![Neptune and TensorFlow logos](https://neptune.ai/wp-content/uploads/2023/09/tensorboard_tensorflow.svg)

# Neptune-TensorBoard integration

See [the official docs](https://docs.neptune.ai/integrations/tensorboard/).
Log TensorBoard-tracked metadata to neptune.ai.

## 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?

* Model summary and predictions
* Training code and Git information
* System metrics and hardware consumption

You can also log:

* Existing TensorBoard logs
* [Other metadata](https://docs.neptune.ai/logging/what_you_can_log)

![Dashboard with TensorBoard metadata](https://docs.neptune.ai/img/app/integrations/tensorboard.png)

## Resources

* [Documentation](https://docs.neptune.ai/integrations/tensorboard/)
* [Code example on GitHub](https://github.com/neptune-ai/examples/tree/main/integrations-and-supported-tools/tensorboard)
* [Example project in the Neptune app](https://app.neptune.ai/o/common/org/tensorboard-integration/runs/details?viewId=standard-view&detailsTab=dashboard&dashboardId=99830fca-15f8-4431-baea-808ae13c0120&shortId=TBOARD-880&type=run)

## Example

Install Neptune and the integration:

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

Enable Neptune logging:

```python
import neptune
from neptune_tensorboard import enable_tensorboard_logging

neptune_run = neptune.init_run(
project="workspace-name/project-name", # replace with your own
tags = ["tensorboard", "test"], # optional
dependencies="infer", # optional
)

enable_tensorboard_logging(neptune_run)
```

Export existing TensorBoard logs:

```sh
neptune tensorboard --api_token YourNeptuneApiToken --project YourNeptuneProjectName logs
```

## 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 [[email protected]](mailto:[email protected]).
Loading