Add license
Browse files- LICENSE.txt +21 -0
- README.md +8 -2
LICENSE.txt
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
MIT License
|
| 2 |
+
|
| 3 |
+
Copyright (c) 2024 University of Luxembourg
|
| 4 |
+
|
| 5 |
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
| 6 |
+
of this software and associated documentation files (the "Software"), to deal
|
| 7 |
+
in the Software without restriction, including without limitation the rights
|
| 8 |
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
| 9 |
+
copies of the Software, and to permit persons to whom the Software is
|
| 10 |
+
furnished to do so, subject to the following conditions:
|
| 11 |
+
|
| 12 |
+
The above copyright notice and this permission notice shall be included in all
|
| 13 |
+
copies or substantial portions of the Software.
|
| 14 |
+
|
| 15 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 16 |
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| 17 |
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| 18 |
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| 19 |
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
| 20 |
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
| 21 |
+
SOFTWARE.
|
README.md
CHANGED
|
@@ -26,13 +26,19 @@ All required libraries and packages are directly loaded inside the notebook.
|
|
| 26 |
To set up the speaking assistant in your car's system, follow these steps:
|
| 27 |
1. Run all the cells until the “Interfaces (text and audio)” section.
|
| 28 |
2. Choose between the interfaces which one to run: audio-to-audio or text-to-text.
|
|
|
|
| 29 |
### Usage
|
| 30 |
1. Model Setup: Begin by loading the necessary models for speech recognition, language processing, and text-to-speech conversion as detailed in the "Models loads" section.
|
| 31 |
2. Function Definition: Customize the assistant's responses and capabilities by defining functions in the "Function calling with NexusRaven" section.
|
| 32 |
3. Interface Configuration: Choose the Gradio interface that suits your in-car system, following setup instructions in the "Interfaces (text and audio)" section.
|
| 33 |
4. Activation: Execute one of the interface to start the speaking assistant, enabling vocal interactions within the car.
|
| 34 |
|
| 35 |
-
## Authors
|
| 36 |
|
| 37 |
Sasan Jafarnejad
|
| 38 |
-
Abigail Berthe--Pardo
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 26 |
To set up the speaking assistant in your car's system, follow these steps:
|
| 27 |
1. Run all the cells until the “Interfaces (text and audio)” section.
|
| 28 |
2. Choose between the interfaces which one to run: audio-to-audio or text-to-text.
|
| 29 |
+
|
| 30 |
### Usage
|
| 31 |
1. Model Setup: Begin by loading the necessary models for speech recognition, language processing, and text-to-speech conversion as detailed in the "Models loads" section.
|
| 32 |
2. Function Definition: Customize the assistant's responses and capabilities by defining functions in the "Function calling with NexusRaven" section.
|
| 33 |
3. Interface Configuration: Choose the Gradio interface that suits your in-car system, following setup instructions in the "Interfaces (text and audio)" section.
|
| 34 |
4. Activation: Execute one of the interface to start the speaking assistant, enabling vocal interactions within the car.
|
| 35 |
|
| 36 |
+
## Authors
|
| 37 |
|
| 38 |
Sasan Jafarnejad
|
| 39 |
+
Abigail Berthe--Pardo
|
| 40 |
+
|
| 41 |
+
|
| 42 |
+
## License
|
| 43 |
+
|
| 44 |
+
KITT is released under the [MIT License](https://opensource.org/licenses/MIT).
|