NVIDIA/NeMo-Retriever

[DOC]: Add process for creating a new Task handler to CONTRIBUTING.md

Open

#16 aberto em 29 de ago. de 2024

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Python (339 forks)auto 404
docgood first issue

Métricas do repositório

Stars
 (2.944 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

How would you describe the priority of this documentation request

Would be nice

Describe the future/missing documentation

This will add a new CONTRIBUTING.md section that outlines the steps for adding a new processing task type, and making it available for use via the client library and cli interface.

  • Task Definition:
    • The process for adding a new task to the CLI and library, including --task specification, and configuration options.
  • Processing Module:
    • How to create a new stage/module that checks a control message for a specified task, extracts the task, operates on the message payload, updates the appropriate elements, and forwards the control message to the next stage.
    • How to add the new stage/module to the pipeline
    • Setting up the module for proper unit testing.

Where have you looked?

No response

Guia do colaborador

Direção de pesquisa
Pilha de tecnologia
Domain
Tipo Issue
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Prerequisites
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.