simulstream 0.1.0__tar.gz

simulstream-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 FBK
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

simulstream-0.1.0/PKG-INFO

@@ -0,0 +1,465 @@
+Metadata-Version: 2.4
+Name: simulstream
+Version: 0.1.0
+Summary: A server to run simultaneous/streaming experiments and demo
+Author-email: Marco Gaido <mgaido@fbk.eu>, FBK HLT-MT <mt@fbk.eu>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright 2023 FBK
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+        
+Project-URL: GitHub, https://github.com/hlt-mt/simulstream
+Project-URL: Issues, https://github.com/hlt-mt/simulstream/issues
+Keywords: simultaneous,demo,websocket,streaming
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyyaml>6.0
+Requires-Dist: websockets
+Requires-Dist: torch
+Requires-Dist: librosa
+Provides-Extra: dev
+Requires-Dist: pytest==7.4.0; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-rtd-theme; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Provides-Extra: hf
+Requires-Dist: transformers==4.48.1; extra == "hf"
+Provides-Extra: canary
+Requires-Dist: Cython; extra == "canary"
+Requires-Dist: nemo_toolkit[asr]==2.4.0; extra == "canary"
+Provides-Extra: vad
+Requires-Dist: silero-vad; extra == "vad"
+Provides-Extra: eval
+Requires-Dist: unbabel-comet==2.2.6; extra == "eval"
+Requires-Dist: mweralign; extra == "eval"
+Requires-Dist: sacrebleu; extra == "eval"
+Dynamic: license-file
+
+<div align="center">
+  <img src="https://github.com/hlt-mt/simulstream/blob/main/docs/source/_static/logo.png?raw=true" width="200" alt="simulstream logo">
+</div>
+
+
+# simulstream
+
+``simulstream`` is a Python library for simultaneous/streaming speech recognition and translation.
+It enables both the simulation with existing files to score systems, like in the
+[SimulEval](https://github.com/facebookresearch/SimulEval) project, and the possibility to run
+demos on a browser.
+
+``simulstream`` provides a WebSocket server and utilities for running streaming speech processing
+experiments and demos. It supports real-time transcription and translation through streaming audio
+input. By streaming, we mean that the library by default assumes that the input is an unbounded
+speech signal, rather than many short speech segments as in simultaneous speech processing.
+The simultaneous setting can be easily addressed by pre-segmenting the audio into many small
+segments and feed each segment to ``simulstream``.
+
+The repository is tested using Python 3.11. Although it may work also with other Python versions,
+we do not ensure compatibility with them. Check out the [Usage](#Usage) section for instructions on
+how to use the repository and the [Installation](#Installation) section for further information
+about how to install the project.
+
+
+## Installation
+
+You can install the latest stable version from PyPI:
+
+```shell
+pip install simulstream
+```
+
+Or, to install from source:
+
+```shell
+git clone https://github.com/hlt-mt/simulstream.git
+cd simulstream
+pip install .
+```
+
+Please notice that these commands will only install the basic functionalities of the repository,
+i.e. the WebSocket server and client. Additionally, you have to install the dependencies required
+by the `speech processor` that you want to use. The repository comes with examples of speech
+processors that rely on e.g. Transformers models or on the NVIDIA Canary model. You can install
+the required dependencies for them by specifying the corresponding selector when installing
+the repository. For instance, using Canary speech processors requires the ``canary`` selector.
+But you can create your custom speech processor and install the corresponding dependencies.
+
+Also the evaluation comes with additional dependencies, which can be installed with the ``eval``
+selector. Be careful as the metrics include COMET, which has dependencies on Transformers and
+other libraries that can run on conflict with those required by your speech processor.
+
+As an example, if you want to install the ``simulstream`` package with Canary speech processors
+and the evaluation package, run:
+
+```shell
+pip install -e .[canary,eval]
+```
+
+For development (with docs and testing tools):
+
+```shell
+pip install -e .[dev]
+```
+
+## Usage
+
+The package is based on a WebSocket client-server interaction. The server waits for connections
+by the clients. The clients can send configurations messages in JSON format (e.g. to specify
+the input/output desired language) and audio chunks, encoded as 16-bit integers. The server
+processes the input audio, generates the transcript/translation by means of the configured
+speech processor and sends it to the client in JSON format. In addition, if configured to do so,
+the server writes logs that can be used to compute metrics in a JSONL file.
+
+To have everything up and running, first run the server and once the server is up and running
+execute one or more clients. The repository contains the code for two types of clients: a web
+interface client that can be used for demos and a python command-line client that can be used
+for testing or evaluation of the speech processor performance.
+
+Below, you can find a simple illustration of the overall architecture with the two scenarios:
+
+<img src="docs/source/_static/architecture.png" alt="Overall simulstream architecture">
+
+To streamline the evaluation of speech processors in terms of quality and latency, there is also
+the possibility to run the inference with a configured speech processor without setting up a
+client-server interaction. For more information, refer to the [Evaluation section](#Evaluation).
+
+### WebSocket Server
+
+Run the WebSocket server with YAML configuration files:
+
+```shell
+simulstream_server --server-config config/server.yaml \
+    --speech-processor-config config/speech_processor.yaml
+```
+
+The repository contains examples of YAML files both for the server and for some speech processors.
+They can be edited and adapted.
+
+#### Customize with Your Speech Processor
+
+If you want to implement your own ``speech_processor``, you need to create a subclass
+of ``simulstream.server.speech_processors.base.SpeechProcessor`` and add the class
+to the ``PYTHONPATH``. Then reference the new class in the YAML file configuration
+of the speech processor. Refer to the dedicated documentation for more
+details on how to implement a speech processor in the project documentation and in the
+docstring of both [``simulstream.server.speech_processors.base.SpeechProcessor``](simulstream/server/speech_processors/__init__.py)
+and [`simulstream.server.speech_processors.base.BaseSpeechProcessor`](simulstream/server/speech_processors/base.py).
+
+As reference, you can check the processors implemented in this repository, available in the
+[`simulstream.server.speech_processors`](simulstream/server/speech_processors) module.
+Notice that each speech processor can have additional dependencies that  are not installed by
+default with this codebase (see [Installation](#installation)).
+
+
+### HTTP Server Web Client
+
+For a demo, you can create an HTTP web server that servers a web interface interacting with the
+WebSocket server. This can be done by:
+
+```shell
+simulstream_demo_http_server --config config/server.yaml -p 8001 --directory webdemo
+```
+
+In case you are not running the command from the root folder of this repository, you should change
+accordingly the ``--directory`` parameter to point to the ``webdemo`` folder containing the HTML
+files of the HTTP demo. You can of course replace ``8001`` with any other port number you prefer.
+The web interface can then be accessed from the local laptop at ``http://localhost:8001/`` or from
+any other terminal connected  to the same network using the IP address of your workstation instead
+of ``localhost``. Be careful not to use the same port specified for the WebSocket server if they
+are running on the same machine. If running the HTTP server from a machine different from the one
+where the WebSocket server runs, ensure that the HTTP server can connect to the WebSocket server
+through the address specified in the ``config/server.yaml`` file.
+
+
+### Python Client
+
+
+If you want to process a set of audio files (e.g. a test set) with your system, send the audios
+with the provided client:
+
+```shell
+simulstream_wavs_client --uri ws://localhost:8080/ \
+    --wav-list-file PATH_TO_TXT_FILE_WITH_A_LIST_OF_WAV_FILES.txt \
+    --tgt-lang it --src-lang en
+```
+
+Tne ``--uri`` should contain the address of the WebSocket client, so it should correspond to what
+is specified in the server YAML config. The file specified in ``--wav-list-file`` should be a TXT
+files containing for each line the path to a WAV file.
+
+Before running the command, ensure that the logging of metrics is enabled in the configuration file
+of the WebSocket server (i.e., ``metrics.enabled = True``) and that metrics are logged to an
+empty/non-existing file, to ensure that the resulting file will contain only the logs related to
+the files sent by the client. Then, compute the relevant scores as described below
+([Evaluation](#Evaluation)).
+
+
+### Evaluation
+
+To evaluate a speech processor, as a first thing you need to run the inference on a test set.
+This can be done either through the Python client (see section above) or through the dedicated
+command that performs the inference without setting up a client-server interaction. This second
+option can be followed by running the dedicated command:
+
+```
+simulstream_inference --speech-processor-config config/speech_processor.yaml \
+    --wav-list-file PATH_TO_TXT_FILE_WITH_A_LIST_OF_WAV_FILES.txt \
+    --tgt-lang it --src-lang en --metrics-log-file metrics.jsonl
+```
+
+Once you have generated the JSONL file containing the inference log (e.g. ``metrics.jsonl``), you
+can score your speech processor by running:
+
+```shell
+simulstream_score_latency --scorer stream_laal \
+    --eval-config config/speech_processor.yaml \
+    --log-file metrics.jsonl \
+    --reference REFERENCE_FILE.txt \
+    --audio-definition YAML_AUDIO_REFERENCES_DEFINITION.yaml
+
+simulstream_score_quality --scorer comet \
+    --eval-config config/speech_processor.yaml \
+    --log-file metrics.jsonl \
+    --references REFERENCES_FILE.txt \
+    --transcripts TRANSCRIPTS_FILE.txt
+
+simulstream_stats --eval-config config/speech_processor.yaml \
+    --log-file metrics.jsonl
+```
+
+Each of them will output different metrics. ``simulstream_score_latency`` provides the metric for
+the latency of the system by leveraging a sentence-based TXT reference file and a YAML file, which
+for each line in the reference TXT contains the WAV file to which it belong, its ``offset``
+(i.e. start time) and ``duration``. The exact definition of how the latency is defined depends on
+the selected metric (``--scorer``).
+
+Similarly, ``simulstream_score_quality`` evaluated the quality
+of the generated outputs against one (or more) reference (and transcript, only for metrics
+requiring them) file(s).
+
+Lastly, ``simulstream_stats`` computes statistics like the computational cost and flickering ratio.
+
+
+## Contributing
+
+Contributions from interested researchers and developers are extremely appreciated.
+
+You can create an ***issue*** in case of problems with the code, questions, or feature requests.
+You are also more than welcome to create a ***pull request*** that addresses any ***issue***.
+
+## Licence
+
+``simulstream`` is licensed under [Apache Version 2.0](LICENSE). 
+
+## Credits
+If you use this library, please cite:
+
+
+```
+@article{gaido-et-al-2025-simulstream,
+    title={{simulstream: Open-Source Toolkit for Evaluation and Demonstration of Streaming Speech-to-Text Translation Systems}},
+    author={Gaido, Marco and Papi, Sara and Cettolo, Mauro and Negri, Matteo and Bentivogli, Luisa},
+    journal = "arXiv",
+    year={2025}
+}
+```