NeMo-Guardrails
NeMo-Guardrails copied to clipboard
NVIDIA
Integrating AutoAlign's guardrail library with NeMo Guardrails
This PR demonstrate how to config and use AutoAlign's guardrail library.
The readme at nemoguardrails/library/autoalign/README.md describes AutoAlign's guardrail configuration and api descriptions.
The following folders have example running setup on how to use AutoAlign:
/examples/configs/autoalign/autoalign_config/
examples/configs/autoalign/autoalign_factcheck_config
And, these AutoAlign setups can be executed from a terminal with
nemoguardrails chat --config=./examples/configs/autoalign/autoalign_config and
nemoguardrails chat --config=./examples/configs/autoalign/autoalign_factcheck_config.
In order to use the AutoAlign, The AUTOALIGN_API_KEY (and relevant model api keys, when needed) has to be setup as environment variables, and user can obtain an AutoAlign key contacting us at [email protected].
One example session with AutoAlign could look like:
ps: @drazvan i dont seem to be able to add you as a reviewer; could you please take a look?
@rahm-decypher / @abhijitpal1247 : is this ready for another review? Feel free to add comments on the discussion items from the first review, or mark as resolved.
@drazvan it is good to review; @abhijitpal1247 had marked issues as resolved. Could you please refer to may last email on how to test locally? Please let us know if you face issues while testing. Thanks very much!
@drazvan wondering, were you able to test the AutoAlign integration? im copying the testing instruction from our earlier conversations below. Please let us know if you face issues while testing. Thanks!
I have tested the autoalign key (J4b98ja7KaJh) locally, and it seems to work. Btw, you will be required to set your open ai key - the example config was set to work with the user's open ai key and model. I followed the sample steps below to start a autoalign guarded chat session:
---------------------------
git clone https://github.com/NVIDIA/NeMo-Guardrails.git
cd NeMo-Guardrails/
git fetch origin pull/395/head:pull_395
git checkout pull_395
pip install -e .
export OPENAI_API_KEY=<your open ai key>
export AUTOALIGN_API_KEY=<your AutoAlign api key, sent via email>
nemoguardrails chat --config examples/configs/autoalign/autoalign_config/
---------------------------
@drazvan no worries; please take a look at the latest update. Thanks.
@rahm-decypher @abhijitpal1247: Thanks for the changes. The only blocking issue now is the fact that not all commits are signed. One way to solve this is :
-
Configure automatic signing of commits (see the Contributing guide).
-
Check out the current develop branch in a separate branch
git remote add nvidia [email protected]:NVIDIA/NeMo-Guardrails.git
git checkout -b nvidia-develop nvidia/develop
- Rebase against that branch. The rebase will automatically re-sign all the commits.
git checkout develop
git rebase nvidia-develop
Because of the rebase you'll have to force-push the branch, or create another PR against a new branch.
Hopefully the above works. Let me know if you need more guidance.
Oh, and also, include the following fix: https://github.com/NVIDIA/NeMo-Guardrails/commit/0cc75f4eddfc8a885e1c14aff37a6a140eeec58f (I could not push directly to your repo, and didn't create another fork).
