From 0eb7be6e96c1852511c1bdd9768a56c87f0144b3 Mon Sep 17 00:00:00 2001 From: Sabine Date: Tue, 14 Mar 2023 11:45:22 +0200 Subject: [PATCH] clean up README (#48) * clean up README * fix links and imports --- README.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index c30ef32..f83ae46 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Neptune + Fastai Integration +# Neptune + fastai integration Experiment tracking, model registry, data versioning, and live model monitoring for fastai trained models. @@ -10,12 +10,12 @@ Experiment tracking, model registry, data versioning, and live model monitoring ## What will be logged to Neptune? -* Hyper-parameters -* Losses & metrics -* Training code (Python scripts or Jupyter notebooks) and git information +* Hyperparameters +* Losses and metrics +* Training code (Python scripts or Jupyter notebooks) and Git information * Dataset version -* Model Configuration, architecture, and weights -* [other metadata](https://docs.neptune.ai/you-should-know/what-can-you-log-and-display) +* Model configuration, architecture, and weights +* [Other metadata](https://docs.neptune.ai/logging/what_you_can_log) ![image](https://user-images.githubusercontent.com/97611089/160639808-bd381089-66c8-4ed5-a895-0c018b378e0a.png) *Example dashboard with train-valid metrics and selected parameters* @@ -23,25 +23,29 @@ Experiment tracking, model registry, data versioning, and live model monitoring ## Resources -* [Documentation](https://docs.neptune.ai/integrations-and-supported-tools/model-training/fastai) +* [Documentation](https://docs.neptune.ai/integrations/fastai) * [Code example on GitHub](https://github.com/neptune-ai/examples/tree/main/integrations-and-supported-tools/fastai/scripts) * [Example dashboard in the Neptune app](https://app.neptune.ai/o/common/org/fastai-integration/e/FAS-61/dashboard/fastai-dashboard-1f456716-f509-4432-b8b3-a7f5242703b6) * [Run example in Google Colab](https://colab.research.google.com/github/neptune-ai/examples/blob/main/integrations-and-supported-tools/fastai/notebooks/Neptune_fastai.ipynb) ## Example -```python -# On the command line: -pip install fastai neptune-client[fastai] +On the command line: + +``` +pip install neptune[fastai] ``` + +In Python: + ```python -# In Python: -import neptune.new as neptune +import neptune # Start a run -run = neptune.init_run(project="common/fastai-integration", - api_token=neptune.ANONYMOUS_API_TOKEN, - source_files=["*.py"]) +run = neptune.init_run( + project="common/fastai-integration", + api_token=neptune.ANONYMOUS_API_TOKEN, +) # Log a single training phase learn = learner(...) @@ -60,7 +64,7 @@ run.stop() If you got stuck or simply want to talk to us, here are your options: -* Check our [FAQ page](https://docs.neptune.ai/getting-started/getting-help#frequently-asked-questions) +* Check our [FAQ page](https://docs.neptune.ai/getting_help) * You can submit bug reports, feature requests, or contributions directly to the repository. * Chat! When in the Neptune application click on 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