From fd4a67f2aeab9e0923c99d6fb40b108eede077cb Mon Sep 17 00:00:00 2001 From: Krystyna Milian Date: Wed, 5 Jul 2023 10:21:22 +0200 Subject: [PATCH] updated readme --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b6cfac9..16fef77 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,16 @@ This repo contains notebooks and scripts demonstrating how to: The original data can be downloaded from the [drive](https://drive.google.com/drive/folders/1InVI9DLaD7gdzraM2jMzeIrtiBSu-UIK?usp=drive_link) - Explore available data, check the [notebook](notebooks/Explore%20igf%20data.ipynb) -- Train cnn model (Seisbench PhaseNet)to detect P phase, check the [script](scripts/train.py) -- Search for the best training hyperparams, check the [script](scripts/training_wandb_sweep.py) +- Train cnn model (Seisbench PhaseNet) to detect P phase, check the [script](scripts/train.py) +- Use Weights & Biases to search for the best training hyperparams, check the [script](scripts/training_wandb_sweep.py) - Validate model performance, check the [notebook](notebooks/Check%20model%20performance%20depending%20on%20station-random%20window.ipynb) - Use model for detecting P phase, check the [notebook](notebooks/Present%20model%20predictions.ipynb) ### Usage -To install all dependencies run: -`poetry install` \ No newline at end of file +1. Install all dependencies with poetry, run: +`poetry install` +2. Prepare .env file with content: + + `WANDB_API_KEY="your key"` \ No newline at end of file