Skip to content

Commit f272bf7

Browse files
committed
Add CHANGELOG.md and CLA.md
1 parent cd95c33 commit f272bf7

File tree

4 files changed

+153
-52
lines changed

4 files changed

+153
-52
lines changed

CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# NVIDIA Pipecat 0.1.0 (23 April 2025)
2+
The NVIDIA Pipecat library augments the Pipecat framework by adding additional frame processors and services, as well as new multimodal frames to enhance avatar interactions. This is the first release of the NVIDIA Pipecat library.
3+
4+
## New Features
5+
6+
- Added Pipecat services for [Riva ASR (Automatic Speech Recognition)](https://docs.nvidia.com/deeplearning/riva/user-guide/docs/asr/asr-overview.html#), [Riva TTS (Text to Speech)](https://docs.nvidia.com/deeplearning/riva/user-guide/docs/tts/tts-overview.html), and [Riva NMT (Neural Machine Translation)](https://docs.nvidia.com/deeplearning/riva/user-guide/docs/translation/translation-overview.html) models.
7+
- Added Pipecat frames, processors, and services to support multimodal avatar interactions and use cases. This includes `Audio2Face3DService`, `AnimationGraphService`, `FacialGestureProviderProcessor`, and `PostureProviderProcessor`.
8+
- Added `ACETransport`, which is specifically designed to support integration with existing [ACE microservices](https://docs.nvidia.com/ace/overview/latest/index.html). This includes a FastAPI-based HTTP and WebSocket server implementation compatible with ACE.
9+
- Added `NvidiaLLMService` for [NIM LLM models](https://build.nvidia.com/) and `NvidiaRAGService` for the [NVIDIA RAG Blueprint](https://github.com/NVIDIA-AI-Blueprints/rag/blob/main/docs/quickstart.md).
10+
- Added `UserTranscriptSynchronization` processor for user speech transcripts and `BotTranscriptSynchronization` processor for synchronizing bot transcripts with bot audio playback.
11+
- Added custom context aggregators and processors to enable [Speculative Speech Processing](https://docs.nvidia.com/ace/ace-controller-microservice/latest/user-guide.html#speculative-speech-processing) to reduce latency.
12+
- Added `UserPresence`, `Proactivity`, and `AcknowledgementProcessor` frame processors to improve human-bot interactions.
13+
- Released source code for the voice assistant example using `nvidia-pipecat`, along with the `pipecat-ai` library service, to showcase NVIDIA services with `ACETransport`.
14+
15+
16+
## Improvements
17+
18+
- Added `ElevenLabsTTSServiceWithEndOfSpeech`, an extended version of the ElevenLabs TTS service with end-of-speech events for usage in avatar interactions.
19+

CLA.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# Contribution License Agreement
2+
3+
This Contribution License Agreement (“**Agreement**”) is agreed to by the party signing below (“**You**”),
4+
and conveys certain license rights to NVIDIA Corporation and its affiliates (“**NVIDIA**”) for Your
5+
contributions to NVIDIA open source projects. This Agreement is effective as of the latest signature
6+
date below.
7+
8+
## 1. Definitions.
9+
10+
**Code**” means the computer software code, whether in human-readable or machine-executable form,
11+
that is delivered by You to NVIDIA under this Agreement.
12+
13+
**Project**” means any of the projects owned or managed by NVIDIA in which software is offered under
14+
a license approved by the Open Source Initiative (OSI) (www.opensource.org) and documentation
15+
offered under an OSI or a Creative Commons license (https://creativecommons.org/licenses).
16+
17+
**Submit**” is the act of uploading, submitting, transmitting, or distributing code or other content to any
18+
Project, including but not limited to communication on electronic mailing lists, source code control
19+
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
20+
discussing and improving that Project, but excluding communication that is conspicuously marked or
21+
otherwise designated in writing by You as “Not a Submission.”
22+
23+
**Submission**” means the Code and any other copyrightable material Submitted by You, including any
24+
associated comments and documentation.
25+
26+
## 2. Your Submission.
27+
You must agree to the terms of this Agreement before making a Submission to any
28+
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
29+
described in Section 4 below), Submit to any Project.
30+
31+
## 3. Originality of Work.
32+
You represent that each of Your Submissions is entirely Your original work.
33+
Should You wish to Submit materials that are not Your original work, You may Submit them separately
34+
to the Project if You (a) retain all copyright and license information that was in the materials as You
35+
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
36+
containing materials of a third party:” followed by the names of the third party and any licenses or other
37+
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
38+
guidelines concerning Submissions.
39+
40+
## 4. Your Employer.
41+
References to “employer” in this Agreement include Your employer or anyone else
42+
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
43+
Submission is made in the course of Your work for an employer or Your employer has intellectual
44+
property rights in Your Submission by contract or applicable law, You must secure permission from Your
45+
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
46+
Agreement will refer to You and the employer collectively. If You change employers in the future and
47+
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
48+
and secure permission from the new employer before Submitting those Submissions.
49+
50+
51+
## 5. Licenses.
52+
53+
**a. Copyright License**. You grant NVIDIA, and those who receive the Submission directly or
54+
indirectly from NVIDIA, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
55+
Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
56+
the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
57+
parties.
58+
59+
**b. Patent License**. You grant NVIDIA, and those who receive the Submission directly or
60+
indirectly from NVIDIA, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
61+
Your patent claims that are necessarily infringed by the Submission or the combination of the
62+
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
63+
import or otherwise dispose of the Submission alone or with the Project.
64+
65+
**c. Other Rights Reserved**. Each party reserves all rights not expressly granted in this Agreement.
66+
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
67+
granted by implication, exhaustion, estoppel or otherwise.
68+
69+
## 6. Representations and Warranties.
70+
You represent that You are legally entitled to grant the above
71+
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
72+
have disclosed under Section 3). You represent that You have secured permission from Your employer to
73+
make the Submission in cases where Your Submission is made in the course of Your work for Your
74+
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
75+
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
76+
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
77+
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
78+
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
79+
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
80+
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
81+
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
82+
83+
## 7. Notice to NVIDIA.
84+
You agree to notify NVIDIA in writing of any facts or circumstances of which
85+
You later become aware that would make Your representations in this Agreement inaccurate in any
86+
respect.
87+
88+
## 8. Information about Submissions.
89+
You agree that contributions to Projects and information about
90+
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
91+
information that You submit with Your Submission.
92+
93+
## 9. Governing Law/Jurisdiction.
94+
Claims arising under this Agreement shall be governed by the laws of Delaware, excluding its principles of conflict of laws and the United Nations Convention on Contracts for the Sale of Goods. The state and/or federal courts residing in Santa Clara County, California shall have exclusive jurisdiction over any dispute or claim arising out of this Agreement. You may not export the Software in violation of applicable export laws and regulations.
95+
96+
## 10. Entire Agreement/Assignment.
97+
This Agreement is the entire agreement between the parties, and
98+
supersedes any and all prior agreements, understandings or communications, written or oral, between
99+
the parties relating to the subject matter hereof. This Agreement may be assigned by NVIDIA.
100+
101+
102+
103+
104+
**Please select one of the options below and sign as indicated.** By signing, You accept and agree to the
105+
terms of this Contribution License Agreement for Your present and future Submissions to NVIDIA.
106+
107+
___ I have sole ownership of intellectual property rights to my Submissions and I am not making
108+
Submissions in the course of work for my employer.
109+
110+
- Name (“You”): _________________________________________
111+
- Signature: _________________________________________
112+
- Date: _________________________________________
113+
- GitHub Login: _________________________________________
114+
- Email: _________________________________________
115+
- Address: _________________________________________
116+
117+
___ I am making Submissions in the course of work for my employer (or my employer has intellectual
118+
property rights in my Submissions by contract or applicable law). I have permission from my
119+
employer to make Submissions and enter into this Agreement on behalf of my employer. By signing
120+
below, the defined term “You” includes me and my employer.
121+
122+
- Company Name: _________________________________________
123+
- Signature: _________________________________________
124+
- By: _________________________________________
125+
- Title: _________________________________________
126+
- Date: _________________________________________
127+
- GitHub Login: _________________________________________
128+
- Email: _________________________________________
129+
- Address: _________________________________________

CONTRIBUTING.md

Lines changed: 2 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -10,52 +10,5 @@ Developer workflow for code contributions is as follows:
1010
2. Git clone the forked repository and push changes to the personal fork.
1111
3. Developers must run changes locally to make sure formatting, linting, and unit test checks pass. Check steps for development with the source in [README.md](./README.md) for more details.
1212
3. Once the code changes are staged on the fork and ready for review, a Pull Request (PR) can be requested to merge the changes from a branch of the fork into a selected branch of upstream.
13-
4. Since there is no CI/CD process in place yet, the PR will be accepted and the corresponding issue closed only after adequate testing has been completed, manually, by the developer and/or repository owners reviewing the code.
14-
15-
16-
## Signing Your Work
17-
We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
18-
19-
Any contribution which contains commits that are not Signed-Off will not be accepted.
20-
To sign off on a commit, use the `--signoff` (or `-s`) option when committing your changes:
21-
22-
`$ git commit -s -m "Add cool feature."`
23-
This will append the following to your commit message:
24-
25-
Signed-off-by: Your Name <[email protected]>
26-
27-
28-
## Developer Certificate of Origin
29-
Version 1.1
30-
31-
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
32-
33-
Everyone is permitted to copy and distribute verbatim copies of this
34-
license document, but changing it is not allowed.
35-
36-
37-
Developer's Certificate of Origin 1.1
38-
39-
By making a contribution to this project, I certify that:
40-
41-
(a) The contribution was created in whole or in part by me and I
42-
have the right to submit it under the open source license
43-
indicated in the file; or
44-
45-
(b) The contribution is based upon previous work that, to the best
46-
of my knowledge, is covered under an appropriate open source
47-
license and I have the right under that license to submit that
48-
work with modifications, whether created in whole or in part
49-
by me, under the same open source license (unless I am
50-
permitted to submit under a different license), as indicated
51-
in the file; or
52-
53-
(c) The contribution was provided directly to me by some other
54-
person who certified (a), (b) or (c) and I have not modified
55-
it.
56-
57-
(d) I understand and agree that this project and the contribution
58-
are public and that a record of the contribution (including all
59-
personal information I submit with it, including my sign-off) is
60-
maintained indefinitely and may be redistributed consistent with
61-
this project or the open source license(s) involved.
13+
4. If you are contributing for the first time, Download [Contribution License Agreement(CLA)](CLA.md) and email a signed CLA to [[email protected]](mailto:[email protected]).
14+
5. Since there is no CI/CD process in place yet, the PR will be accepted and the corresponding issue closed only after adequate testing has been completed, manually, by the developer and/or repository owners reviewing the code.

examples/speech-to-speech/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ From the example directory, run below commands:
4242
```bash
4343
cd riva_quickstart_v2.19.0
4444
chmod +x riva_init.sh riva_clean.sh riva_start.sh
45-
bash riva_clean.sh ../utils/riva_config.sh
46-
bash riva_init.sh ../utils/riva_config.sh
47-
bash riva_start.sh ../utils/riva_config.sh
45+
bash riva_clean.sh ../../utils/riva_config.sh
46+
bash riva_init.sh ../../utils/riva_config.sh
47+
bash riva_start.sh ../../utils/riva_config.sh
4848
cd ..
4949
```
5050

0 commit comments

Comments
 (0)