mirror of
https://github.com/hoshikawa2/nemo_guardrails_configuration.git
synced 2026-07-09 17:04:20 +00:00
Enhance README with file descriptions
Updated README.md to provide detailed descriptions for configuration files and scripts.
This commit is contained in:
33
README.md
33
README.md
@@ -432,23 +432,30 @@ Exemplo:
|
|||||||
```text
|
```text
|
||||||
nemo_guardrails_tracing_project/
|
nemo_guardrails_tracing_project/
|
||||||
├── config/
|
├── config/
|
||||||
│ ├── config.yml
|
│ ├── config.yml : Arquivo de configuração para o Nemo Guardrail (Modelos, definições de rails de input e output)
|
||||||
│ ├── rails.co
|
│ ├── config.py : Registro das ações para os guardrails
|
||||||
|
│ ├── guardrails.yaml : Arquivo de mapeamento dos rails conforme definição da Planilha inicial (não utilizado pelo código)
|
||||||
|
│ ├── rails/
|
||||||
|
│ ├─────input.co : configuração de entrada dos fluxos Nemo
|
||||||
|
│ ├─────output.co : configuração de saída dos fluxos Nemo
|
||||||
│ └── guardrails_catalog.json
|
│ └── guardrails_catalog.json
|
||||||
├── src/
|
├── src/
|
||||||
│ ├── app.py
|
│ ├── app.py : demo para consumir rails sem uso de Nemo Guardrails
|
||||||
│ ├── deterministic_rails.py
|
│ ├── app_nemo.py : demo para consumir rails com uso de Nemo Guardrails
|
||||||
│ ├── supervisor.py
|
│ ├── actions.py : Arquivo de Actions expondo deterministic_rails e llm_rails
|
||||||
│ ├── curadoria.py
|
│ ├── deterministic_rails.py : rails deterministicos para serem utilizados como modelo na estrutura
|
||||||
│ ├── tracing.py
|
│ ├── judges.py : estrutura demo para ilustrar judge
|
||||||
│ └── settings.py
|
│ ├── llm_client.py : mockup para demo llm
|
||||||
|
│ ├── llm_rails.py : rails llm para serem utilizados como modelo na estrutura
|
||||||
|
│ ├── models.py : classe do modelo de resposta dos rails
|
||||||
|
│ ├── registry.py : modelo de registry do guardrail
|
||||||
|
│ └── prompts/ : pasta com os prompts para rails que utilizam llm
|
||||||
├── tests/
|
├── tests/
|
||||||
│ └── test_guardrails.py
|
│ └── test_guardrails.py : código utilizado para pytest
|
||||||
├── scripts/
|
├── scripts/
|
||||||
│ ├── run_demo.sh
|
│ └── run_tests.sh : bash script para testar os rails individualmente via pytest
|
||||||
│ └── run_tests.sh
|
├── requirements.txt : bibliotecas necessárias para o projeto
|
||||||
├── requirements.txt
|
├── .env.example : variáveis de ambiente para configuração
|
||||||
├── .env.example
|
|
||||||
└── README.md
|
└── README.md
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user