Skip to content

Commit 09cddef

Browse files
drazvandrazvan
committed
Release 0.1.0.
0 parents  commit 09cddef

File tree

196 files changed

+16037
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

196 files changed

+16037
-0
lines changed

‎.gitignore

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.idea
2+
venv*
3+
env*
4+
temp
5+
__pycache__
6+
*.pyc
7+
.DS_Store
8+
.cache
9+
.coverage
10+
coverage.xml
11+
.pytest_cache
12+
.eggs
13+
mellon.egg-info
14+
scratch.py
15+
.vscode
16+
*.egg-info
17+
firebase.json
18+
build
19+
dist

‎.pre-commit-config.yaml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.4.0
4+
hooks:
5+
- id: check-yaml
6+
- id: end-of-file-fixer
7+
- id: trailing-whitespace
8+
- repo: https://github.com/pycqa/isort
9+
rev: 5.12.0
10+
hooks:
11+
- id: isort
12+
args: [ "--profile", "black" ]
13+
name: isort (python)
14+
- repo: https://github.com/psf/black
15+
rev: 23.3.0
16+
hooks:
17+
- id: black
18+
- repo: https://github.com/Lucas-C/pre-commit-hooks
19+
rev: v1.4.2
20+
hooks:
21+
- id: insert-license
22+
files: \.py$
23+
args:
24+
- --license-filepath
25+
- LICENSE.md
26+
27+
# Deactivating this for now.
28+
# - repo: https://github.com/pycqa/pylint
29+
# rev: v2.17.0
30+
# hooks:
31+
# - id: pylint
32+
# language_version: python3.9

‎CHANGELOG.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [0.1.0] - 2023-04-25
8+
9+
### Added
10+
- First alpha release.

‎CONTRIBUTING.md

+123
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# Contributing to NeMo Guardrails
2+
3+
Thank you for your interest in contributing to NeMo Guardrails! This document will help you get started with setting up your development environment and provide some guidelines for contributing.
4+
5+
## Setting Up the Development Environment
6+
7+
1. Ensure you have Python 3.x installed on your system. You can check your Python version by running:
8+
9+
```
10+
python --version
11+
```
12+
13+
2. Create a virtual environment to isolate your project's dependencies:
14+
15+
```
16+
python -m venv colang_venv
17+
```
18+
19+
Replace `colang_venv` with the desired name for your virtual environment directory.
20+
21+
3. Activate the virtual environment:
22+
23+
- On Windows:
24+
25+
```
26+
nemoguardrails_venv\Scripts\activate
27+
```
28+
29+
- On macOS and Linux:
30+
31+
```
32+
source nemoguardrails_venv/bin/activate
33+
```
34+
35+
4. Clone the project repository:
36+
37+
```
38+
git clone https://github.com/NVIDIA/NeMo-Guardrails.git
39+
```
40+
41+
5. Navigate to the project directory:
42+
43+
```
44+
cd nemoguardrails
45+
```
46+
47+
6. Install the development dependencies from `requirements-dev.txt`:
48+
49+
```
50+
pip install -r requirements-dev.txt
51+
```
52+
53+
This will install pre-commit, pylint, mypy, and any other development tools specified in the `requirements-dev.txt` file.
54+
55+
7. Set up pre-commit hooks:
56+
57+
```
58+
pre-commit install
59+
```
60+
61+
This will ensure that the pre-commit checks, including Black, pylint, and mypy, are run before each commit.
62+
63+
## Folder Structure
64+
65+
The project is structured as follows:
66+
- `nemoguardrails/actions/`: implementation of various actions.
67+
- `nemoguardrails/cli/`: implementation of the NeMo Guardrails CLI.
68+
- `nemoguardrails/flows/`: implementation of the Colang Flows runtime.
69+
- `nemoguardrails/language/`: Colang language parser.
70+
- `nemoguardrails/llm`: various utilities for working with LLMs.
71+
- `nemoguardrails/rails/`: implementation of various rails systems.
72+
- `nemoguardrails/rails/llm`: rails for LLMs.
73+
74+
## Coding Style
75+
76+
We follow the Black coding style for this project.
77+
78+
## Submitting Your Changes
79+
80+
Once you have made your changes and ensured they follow the coding style, you can submit a pull request on GitHub. Please provide a clear and concise description of the changes you've made, and reference any related issues or discussions.
81+
82+
### Signing Your Work
83+
84+
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.
85+
86+
Any contribution which contains commits that are not Signed-Off will not be accepted.
87+
88+
To sign off on a commit you simply use the `--signoff` (or `-s`) option when committing your changes:
89+
```bash
90+
$ git commit -s -m "Add cool feature."
91+
```
92+
This will append the following to your commit message:
93+
```
94+
Signed-off-by: Your Name <[email protected]>
95+
```
96+
97+
Full text of the DCO:
98+
99+
```
100+
Developer Certificate of Origin
101+
Version 1.1
102+
103+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
104+
1 Letterman Drive
105+
Suite D4700
106+
San Francisco, CA, 94129
107+
108+
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
109+
110+
Developer's Certificate of Origin 1.1
111+
112+
By making a contribution to this project, I certify that:
113+
114+
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
115+
116+
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
117+
118+
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
119+
120+
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
121+
```
122+
123+
Thank you for contributing to NeMo Guardrails!

‎LICENCES-3rd-party

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Chatbot-UI
2+
3+
MIT License
4+
Attribution Statements: Nvidia actively chooses the MIT license to apply to files with this copyright and license.
5+
6+
Copyright (c) 2023 Mckay Wrigley
7+
8+
Permission is hereby granted, free of charge, to any person obtaining a copy
9+
of this software and associated documentation files (the "Software"), to deal
10+
in the Software without restriction, including without limitation the rights
11+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12+
copies of the Software, and to permit persons to whom the Software is
13+
furnished to do so, subject to the following conditions:
14+
15+
The above copyright notice and this permission notice shall be included in all
16+
copies or substantial portions of the Software.
17+
18+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24+
SOFTWARE.

‎LICENSE-Apache-2.0.txt

+177
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

0 commit comments

Comments
 (0)