echogarden 0.5.1 → 0.5.2

package/README.md

@@ -1,6 +1,6 @@
 # Echogarden
 
-Echogarden is a versatile speech processing system that attempts to address the needs of end-users:
+Echogarden is an integrated speech system that provides a range of speech generation, recognition and processing tools that are designed to be directly usable by end-users:
 
 * Written in TypeScript, for the Node.js runtime
 * Easy to install, run and update
@@ -12,11 +12,11 @@ Echogarden is a versatile speech processing system that attempts to address the
 
 * Fast, high-quality offline text-to-speech voices based on the [VITS](https://github.com/jaywalnut310/vits) neural architecture
 * Accurate offline speech recognition using [OpenAI Whisper](https://openai.com/research/whisper) models
-* Supports synthesis and recognition via major cloud providers, including Google, Microsoft and Amazon
+* Supports synthesis and recognition via a [variety of offline and cloud engines](docs/Engines.md), including Google, Microsoft and Amazon
 * Word-level timestamps for all synthesis and recognition outputs
 * Speech-to-transcript alignment using dynamic time warping (DTW), and dynamic time warping with recognition assist (DTW-RA) methods
 * Advanced subtitle generation, accounting for sentence and phrase boundaries
-* Can transcribe speech in any one of 98 languages, translated directly to English, and produce near word-level synchronized subtitles for the translated transcript
+* Can translate speech in any one of 98 languages, transcribe it directly to English, and produce near word-level synchronized subtitles for the translated transcript
 * Attempts to improve TTS pronunciation accuracy for a few engines and languages (currently only implemented for English dialects): adds text normalization (e.g. idiomatic date and currency pronunciation), heteronym disambiguation (based on a custom rule-based model) and user-customizable pronunciation lexicons
 * Internal package system that auto-downloads and installs voices, models and other resources, as needed
 * Other features include: language detection (both for audio and text), voice activity detection, and speech denoising
@@ -46,7 +46,16 @@ npm update echogarden -g
 
 Currently, the software is operated mainly through a [command-line interface](docs/CLI.md), which enables powerful customization and is especially useful for long-running bulk operations.
 
-Development of more graphical and interactive tooling is currently ongoing. A general roadmap is shown next.
+Development of more graphical and interactive tooling is currently ongoing. A general roadmap is shown further down below.
+
+## Guides and resource pages
+
+* [Using the command-line interface](docs/CLI.md)
+* [Options reference](docs/Options.md)
+* [Full list of supported engines](docs/Engines.md)
+* [Technical overview and Q&A](docs/Technical.md)
+* [Developer's task list](docs/Tasklist.md)
+* [How to help](docs/Development.md)
 
 ## Development roadmap
 
@@ -56,7 +65,7 @@ _(For much more detailed information, see the [developer task list](docs/Tasklis
 
 * (**90**%) Background worker
 * (**90**%) WebSocket-based server and API
-* (**70**%) Browser extension, acting as a bridge to a local or self-hosted server. Also including integration with the Web Speech API, and real-time narration of page content, with live word highlighting
+* (**70**%) Browser extension, acting as a bridge to a local or self-hosted server. Includes integration with the Web Speech API, and real-time narration of page content, with live word highlighting
 * (**60**%) New, high-accuracy text language identification model (own work)
 
 ### Planned, but not yet started
@@ -70,15 +79,6 @@ _(For much more detailed information, see the [developer task list](docs/Tasklis
 
 * Browser port for a subset of the API (in particular for the offline TTS models and their dependencies)
 
-## Guides and resource pages
-
-* [Using the command-line interface](docs/CLI.md)
-* [Options reference](docs/Options.md)
-* [Full list of supported engines](docs/Engines.md)
-* [Technical overview and Q&A](docs/Technical.md)
-* [Developer's task list](docs/Tasklist.md)
-* [How to help](docs/Development.md)
-
 ## Credits
 
 This project consolidates, and builds upon the effort of many different individuals and companies, as well as contributing a number of original works.

package/data/lexicons/heteronyms.en.json

@@ -104,7 +104,7 @@
 			],
 
 			"succeededBy": [
-				"itself", "us", "opportunities", "them", "his", "her", "our", "my", "its", "this", "no", "some", "another", "different", "various", "several", "many", "few", "other", "unique", "special", "great", "excellent", "nice"
+				"itself", "us", "opportunities", "them", "a", "an", "his", "her", "our", "my", "its", "this", "no", "some", "another", "different", "various", "several", "many", "few", "other", "unique", "special", "great", "excellent", "nice"
 			],
 
 			"notSucceededBy": [

package/docs/CLI.md

@@ -10,7 +10,9 @@ Here's a quick tour of the main operations available via the CLI.
 
 Each command can accepts one or more options, in the form `--[optionName]=[value]` (The `=` is required). A detailed reference of all the available options can be found [here](Options.md).
 
-While the program is running, you can press `esc` to immediately exit, or, during audio playback, `enter` to skip it.
+**Keyboard shortcuts**:
+* While the program is running, you can press `esc` to exit immediately
+* When audio is playing, you can press `enter` to skip it
 
 ## Text to speech
 
@@ -46,12 +48,12 @@ The CLI supports multiple output files. This would synthesize a text file, and s
 echogarden speak-file text.txt result.mp3 result.wav result.srt --engine=vits --speed=1.1
 ```
 
-Synthesize a web page (will try to extract its main article parts and omit the rest):
+Synthesize a web page (it will try to extract its main article parts and omit the rest):
 ```bash
 echogarden speak-url https://example.com/hola
 ```
 
-Synthesize a Wikipedia article in any of its language editions:
+Synthesize a Wikipedia article, in any of its language editions:
 ```bash
 echogarden speak-wikipedia "Psychologie" --language=fr
 ```
@@ -200,7 +202,7 @@ Try to identify the language of a text file, and print the probabilities to the
 echogarden detect-text-language story.txt
 ```
 
-Try to identify the language of a text file, and store the probabilities in a JSON file:
+Try to identify the language of a text file, and store the detailed probabilities in a JSON file:
 ```bash
 echogarden detect-text-language story.txt detection-results.json
 ```

package/docs/Options.md

@@ -1,6 +1,10 @@
 # Configuration options reference
 
-For a comprehensive list of all supported engines: see [this page](Engines.md).
+Here is a detailed reference for the options accepted by the Echogarden API and CLI.
+
+Related resources you may need:
+* [A comprehensive list of all supported engines](Engines.md)
+* [A guide on how to use the command line interface](CLI.md)
 
 ## Synthesis
 

package/docs/Tasklist.md

@@ -39,6 +39,7 @@
 * Button or keyboard shortcut to show and hide handles
 * Show blinking placeholder when synthesis is loading for a particular text node
 * Navigate paragraphs or sentences with keyboard shortcuts
+* Minimum size when iterating text nodes to get handle
 
 ### Worker
 * Optionally omit unnecessary data from the response (decoded input, segment data, etc.)

package/docs/Technical.md

@@ -2,7 +2,7 @@
 
 * Echogarden is written in TypeScript and targets the Node.js platform.
 * It uses ESM modules and latest ECMAScript and TypeScript features.
-* It does not depend on essential binary executables. Instead, all of its engines either use pure JavaScript, WebAssembly, WASI, or the ONNX runtime (with some exceptions: the CLI does invoke a few binary executables, loaded from expansion packages, for the `SoX` and `ffmpeg` tools.Using expansion packages simplifies the installation and ensures non-buggy version are used. Since SoX `v14.4.2` is broken on Windows, it bundles `v14.4.1`).
+* It does not depend on essential binary executables. Instead, all of its engines either use pure JavaScript, WebAssembly, WASI, or the ONNX runtime, with some exceptions: the CLI does invoke a few binary executables, loaded from expansion packages, for the `SoX` and `ffmpeg` tools. Using expansion packages simplifies the installation and ensures non-buggy version are used. Since SoX `v14.4.2` is broken on Windows, it bundles `v14.4.1`.
 * It does not depend on essential native node.js modules requiring compilation with `node-gyp`. This greatly simplifies the installation experience for end-users (the ONNX runtime bundles precompiled NAPI modules for all supported platforms - it doesn't require any compilation during its installation).
 
 ## Package system
@@ -34,7 +34,7 @@ Currently, the biggest contributors to the size are:
 
 `onnxruntime-node` is big because it bundles pre-compiled binaries for multiple platforms. `kuromoji` is large because of its dictionary files and some unessential test code it bundles. The other three packages include large WASM binaries.
 
-So, yes, in the future it may be possible to reduce the core installed size by dynamically installing some of these dependencies, or using modified, "slimmed-down" custom versions.
+So, yes, in the future it may be possible to reduce the core installed size by dynamically installing some of these dependencies, or using modified, "slimmed-down" versions of some packages.
 
 ## Since the code is almost all JavaScript and WASM, why can't it just run in a web browser?
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "echogarden",
-	"version": "0.5.1",
+	"version": "0.5.2",
 	"description": "A fully open-source speech system designed with end-users in mind.",
 	"author": "Rotem Dan",
 	"license": "GPL-3.0-only",