From 06dac652f4016ef330ae3d74cdf748d9db394c81 Mon Sep 17 00:00:00 2001 From: Stefan Reck <stefan.reck@fau.de> Date: Tue, 13 Apr 2021 14:56:12 +0200 Subject: [PATCH] docs --- docs/getting_started.rst | 8 ++++---- docs/orcasong.rst | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/getting_started.rst b/docs/getting_started.rst index fd0babb..b0fa1d5 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -20,13 +20,13 @@ the 'h5extract' command of km3pipe like so:: yourself and let people know. -Step 2: From h5 aanet files to DL files ---------------------------------------- -Produce DL files from the aanet h5 files using OrcaSong. +Step 2: From h5 aanet files to h5 DL files +------------------------------------------ +Produce DL h5 files from the aanet h5 files using OrcaSong. You can either produce images or graphs. See :ref:`orcasong_page` for instructions on how to do this. -The resulting DL files can already be used as input for networks! +The resulting DL h5 files can already be used as input for networks! Step 3: Concatenate ------------------- diff --git a/docs/orcasong.rst b/docs/orcasong.rst index 7ad9019..659e46c 100644 --- a/docs/orcasong.rst +++ b/docs/orcasong.rst @@ -1,10 +1,10 @@ .. _orcasong_page: -Producing DL files from h5 -========================== +Producing DL h5 files from aanet h5 files +========================================= -Describes how to use OrcaSong to produce files for Deep Learning -from h5 files. These files can contain either images (for convolutional +Describes how to use OrcaSong to produce h5 files for Deep Learning +from aanet h5 files. These files can contain either images (for convolutional networks), or graphs (for Graph networks). .. contents:: :local: -- GitLab