Pular para conteúdo

CLI Oficial

O projeto tem uma CLI publica que centraliza treino, resume, avaliacao, benchmark, exemplos, governanca e automacao de qualidade.

Usando sem instalar script global

python -m rede_neural_do_zero --help
python -m rede_neural_do_zero train --help

Usando via pacote instalado

rede-neural-do-zero --help
rnz --help

Quatro comandos para comecar

python -m rede_neural_do_zero example --config configs/example/wine.json
python -m rede_neural_do_zero train --config configs/train/iris.yaml
python -m rede_neural_do_zero evaluate --config configs/evaluate/diabetes.toml
python -m rede_neural_do_zero verify --build-package

Comandos principais

train

Treina um modelo, salva parametros, checkpoint completo, resumo JSON e a configuracao efetiva da execucao.

python -m rede_neural_do_zero train --dataset iris --epochs 160 --save-dir results/iris
python -m rede_neural_do_zero train --config configs/train/iris.yaml

resume

Retoma um treino completo a partir de um checkpoint salvo.

python -m rede_neural_do_zero resume --checkpoint results/iris/model-checkpoint.npz --dataset iris --epochs 40

evaluate

Roda uma avaliacao deterministica com gate minimo.

python -m rede_neural_do_zero evaluate --dataset diabetes --min-score 0.20
python -m rede_neural_do_zero evaluate --config configs/evaluate/diabetes.toml

benchmark

Executa benchmark com multiplas seeds, media, desvio, ranking e relatorio Markdown.

python -m rede_neural_do_zero benchmark --mode multiclasse --dataset wine --seeds 42,52,62
python -m rede_neural_do_zero benchmark --datasets iris,wine,diabetes --seeds 42,52,62
python -m rede_neural_do_zero benchmark --config configs/benchmark/suite.yaml

example

Executa um fluxo pronto com datasets sinteticos ou reais.

python -m rede_neural_do_zero example --dataset xor
python -m rede_neural_do_zero example --config configs/example/wine.json

build-docs

Exporta notebooks e monta o site da documentacao.

python -m rede_neural_do_zero build-docs --strict --check-links

build-package

Gera wheel e sdist, com opcao de validar metadados.

python -m rede_neural_do_zero build-package --check

check-branch

Valida nomes de branch pelo padrao oficial do projeto.

python -m rede_neural_do_zero check-branch --name feat/add-branch-policy --target develop
python -m rede_neural_do_zero check-branch --name hotfix/fix-release-link --target main

release-notes

Extrai a secao oficial do CHANGELOG.md para virar release notes ou draft release.

python -m rede_neural_do_zero release-notes --version v2.5.0
python -m rede_neural_do_zero release-notes --json --output logs/release-notes.md

release-check

Valida changelog, versoes e release notes antes de criar tag ou publicar uma release.

python -m rede_neural_do_zero release-check
python -m rede_neural_do_zero release-check --json

pypi-status

Mostra o estado atual do pacote no PyPI e os campos oficiais esperados pelo Trusted Publisher.

python -m rede_neural_do_zero pypi-status

governance-report

Carrega um retrato oficial do repositorio, incluindo Pages, workflows, branch protection e CODEOWNERS.

python -m rede_neural_do_zero governance-report

release-status

Confere se versao local, draft release, Pages e PyPI estao alinhados.

python -m rede_neural_do_zero release-status

rules-check

Executa as checagens oficiais de governanca e falha se algo importante estiver fora do padrao esperado.

python -m rede_neural_do_zero rules-check

pr-summary

Resume um PR local com labels sugeridas, areas tocadas, branch-base recomendada e reviewers do CODEOWNERS.

python -m rede_neural_do_zero pr-summary
python -m rede_neural_do_zero pr-summary --head feat/improve-pages --base develop

verify

Executa lint, tipos, testes, notebooks, docs e, opcionalmente, build do pacote.

python -m rede_neural_do_zero verify
python -m rede_neural_do_zero verify --build-package

Arquivos de configuracao

Os subcomandos train, resume, evaluate, benchmark e example aceitam --config.

Formatos suportados:

  • JSON
  • TOML
  • YAML

Estrutura recomendada:

common:
  seed: 42
  no_plots: true

train:
  dataset: iris
  epochs: 180
  save_dir: experiments/runs/iris-baseline

Se o mesmo campo aparecer no arquivo e na linha de comando, a flag explicita vence.

Qual comando usar em cada caso

  • quer ver o projeto rodando: example
  • quer treinar e salvar artefatos: train
  • quer continuar um treino salvo: resume
  • quer medir um setup com menos variacao: evaluate
  • quer comparar configuracoes: benchmark
  • quer preparar release notes oficiais: release-notes
  • quer validar o pacote oficial de release: release-check
  • quer checar se o PyPI esta pronto para publicar: pypi-status
  • quer enxergar o estado oficial do repositorio: governance-report
  • quer validar regras de governanca antes de mexer no GitHub: rules-check
  • quer entender se a release esta pronta: release-status
  • quer resumir um PR local: pr-summary
  • quer validar o repositorio inteiro: verify