From ceb87ed3372bf0be2d8873d6db4794723315e1ce Mon Sep 17 00:00:00 2001 From: haixuanTao Date: Wed, 9 Oct 2024 13:03:28 +0200 Subject: [PATCH] Update the readme for making the demo more impactful --- examples/translation/README.md | 18 +++++-- examples/translation/dataflow.yml | 47 ------------------- .../{dataflow_en.yml => dataflow_en_zh.yml} | 0 ...rminal.yml => dataflow_en_zh_terminal.yml} | 0 ...o.yml => dataflow_en_zh_terminal_argo.yml} | 0 .../{dataflow_fr.yml => dataflow_fr_en.yml} | 0 .../{dataflow_cn.yml => dataflow_zh_en.yml} | 0 ...rminal.yml => dataflow_zh_en_terminal.yml} | 0 8 files changed, 14 insertions(+), 51 deletions(-) delete mode 100644 examples/translation/dataflow.yml rename examples/translation/{dataflow_en.yml => dataflow_en_zh.yml} (100%) rename examples/translation/{dataflow_en_terminal.yml => dataflow_en_zh_terminal.yml} (100%) rename examples/translation/{dataflow_en_terminal_argo.yml => dataflow_en_zh_terminal_argo.yml} (100%) rename examples/translation/{dataflow_fr.yml => dataflow_fr_en.yml} (100%) rename examples/translation/{dataflow_cn.yml => dataflow_zh_en.yml} (100%) rename examples/translation/{dataflow_cn_terminal.yml => dataflow_zh_en_terminal.yml} (100%) diff --git a/examples/translation/README.md b/examples/translation/README.md index 3af2c6a24..73fc637b4 100644 --- a/examples/translation/README.md +++ b/examples/translation/README.md @@ -3,12 +3,22 @@ Make sure to have, dora, pip and cargo installed. ```bash -# Install rerun if it's not done already dora up -dora build dataflow_cn_terminal.yml -dora start dataflow_cn_terminal.yml +## For chinese +dora build dataflow_zh_en_terminal.yml +dora start dataflow_zh_en_terminal.yml --detach -# In another terminal python pretty_print.py + +dora stop + + +## For chinese +dora build dataflow_en_zh_terminal.yml +dora start dataflow_en_zh_terminal.yml --detach + +python pretty_print.py + +dora stop ``` diff --git a/examples/translation/dataflow.yml b/examples/translation/dataflow.yml deleted file mode 100644 index 55e41033f..000000000 --- a/examples/translation/dataflow.yml +++ /dev/null @@ -1,47 +0,0 @@ -nodes: - - id: dora-microphone - build: pip install -e ../../node-hub/dora-microphone - path: dora-microphone - outputs: - - audio - - - id: dora-vad - build: pip install -e ../../node-hub/dora-vad - path: dora-vad - inputs: - audio: dora-microphone/audio - outputs: - - audio - - - id: dora-distil-whisper - build: pip install -e ../../node-hub/dora-distil-whisper - path: dora-distil-whisper - inputs: - input: dora-vad/audio - outputs: - - text - env: - TARGET_LANGUAGE: chinese - TRANSLATE: false - - - id: dora-argotranslate - build: pip install -e ../../node-hub/dora-argotranslate - path: dora-argotranslate - inputs: - text: - source: dora-distil-whisper/text - queue_size: 1 - outputs: - - text - env: - SOURCE_LANGUAGE: zh - TARGET_LANGUAGE: en - - - id: plot - build: cargo build -p dora-rerun --release - path: dora-rerun - inputs: - text: dora-argotranslate/text - env: - IMAGE_WIDTH: 640 - IMAGE_HEIGHT: 480 diff --git a/examples/translation/dataflow_en.yml b/examples/translation/dataflow_en_zh.yml similarity index 100% rename from examples/translation/dataflow_en.yml rename to examples/translation/dataflow_en_zh.yml diff --git a/examples/translation/dataflow_en_terminal.yml b/examples/translation/dataflow_en_zh_terminal.yml similarity index 100% rename from examples/translation/dataflow_en_terminal.yml rename to examples/translation/dataflow_en_zh_terminal.yml diff --git a/examples/translation/dataflow_en_terminal_argo.yml b/examples/translation/dataflow_en_zh_terminal_argo.yml similarity index 100% rename from examples/translation/dataflow_en_terminal_argo.yml rename to examples/translation/dataflow_en_zh_terminal_argo.yml diff --git a/examples/translation/dataflow_fr.yml b/examples/translation/dataflow_fr_en.yml similarity index 100% rename from examples/translation/dataflow_fr.yml rename to examples/translation/dataflow_fr_en.yml diff --git a/examples/translation/dataflow_cn.yml b/examples/translation/dataflow_zh_en.yml similarity index 100% rename from examples/translation/dataflow_cn.yml rename to examples/translation/dataflow_zh_en.yml diff --git a/examples/translation/dataflow_cn_terminal.yml b/examples/translation/dataflow_zh_en_terminal.yml similarity index 100% rename from examples/translation/dataflow_cn_terminal.yml rename to examples/translation/dataflow_zh_en_terminal.yml