From 33649fccd2711dd97c63443bf7a857afe803c42f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C3=ABl=20Defferrard?= <michael.defferrard@epfl.ch>
Date: Fri, 17 Nov 2017 17:56:00 +0100
Subject: [PATCH] creation.ipynb: update doc on creation.py

---
 creation.ipynb | 38 +++++++++-----------------------------
 1 file changed, 9 insertions(+), 29 deletions(-)

diff --git a/creation.ipynb b/creation.ipynb
index 8cb2b9d8..96291fdb 100644
--- a/creation.ipynb
+++ b/creation.ipynb
@@ -15,12 +15,15 @@
     "* `genres.csv`: genre hierarchy.\n",
     "* `echonest.csv`: cleaned Echonest features.\n",
     "\n",
-    "A companion script, [creation.py](creation.py):\n",
-    "1. Query the [API](https://freemusicarchive.org/api) and store metadata in `raw_tracks.csv`, `raw_albums.csv`, `raw_artists.csv` and `raw_genres.csv`.\n",
-    "2. Download the audio for each track.\n",
-    "3. Trim the audio to 30s clips.\n",
-    "4. Normalize the permissions and modification / access times.\n",
-    "5. Create the `.zip` archives."
+    "Before executing this notebook, run the bellow long-term jobs from the companion script, [creation.py](creation.py):\n",
+    "1.`./creation.py metadata` to query the [API](https://freemusicarchive.org/api) and store metadata in `raw_tracks.csv`, `raw_albums.csv`, `raw_artists.csv` and `raw_genres.csv`.\n",
+    "1. `./creation.py data /path/to/fma/fma_full` to download the audio for each track.\n",
+    "1. `./creation.py mp3_metadata /path/to/fma/fma_full` to extract technical metadata from the audio, e.g. duration.\n",
+    "1. `./creation.py clips /path/to/fma` to extract 30s clips from the downloaded full-length audio.\n",
+    "\n",
+    "After executing the notebook, run:\n",
+    "1. `./creation.py normalize /path/to/fma` to normalize the permissions and modification / access times.\n",
+    "1. `./creation.py zips /path/to/fma` to create the `.zip` archives."
    ]
   },
   {
@@ -72,19 +75,6 @@
     "* To update user data: we need to get all tracks again."
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# ./creation.py metadata\n",
-    "# ./creation.py data /path/to/fma/fma_full\n",
-    "# ./creation.py clips /path/to/fma\n",
-    "\n",
-    "#!cat creation.py"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -1074,16 +1064,6 @@
     "    eval(dataset).to_csv(dataset + '.csv', **params)"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# ./creation.py normalize /path/to/fma\n",
-    "# ./creation.py zips /path/to/fma"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},