Update the client-service guide to explain training and uploading separately

Aberta Para iniciantes
  • Algo errado?
#266 0 comentários 0 reações 1 responsável Ver no GitHub

Mantenedores costumam responder em até 1 dia

@Santiagocetran já está trabalhando nisso.

Desde 29/10/2026.

  • #304 de @Santiagocetran — aberto

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
76/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

Encontre o guia técnico e os comentários do serviço que mencionem train_client_model_and_upload_to_ipfs ou descrevam o treinamento como um upload; a issue não informa os caminhos dos arquivos. Leia o manifesto atual e as descrições do serviço e compare-os com o fluxo de trabalho train-lms e submit-lm descrito na issue. O trabalho estará concluído quando o guia e os comentários explicarem o treinamento e o upload/envio como etapas separadas e usarem o nome atual da função, sem alterar o comportamento dos comandos.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Following up on my local DevNet testing report (#260). These findings are from my October 9–10, 2026 tests.

The technical guide still describes an older workflow where training and uploading happened together. Updating it would make the current steps easier to follow.

From the report:

The guide names train_client_model_and_upload_to_ipfs, while the current manifest and service use train_client_model. The guide also makes it sound as though the training service handles the upload.

In the current workflow, train-lms prepares inputs and runs the worker, which returns a local model file. The separate submit-lm command uploads and submits it. The service's own description still mentions uploading, so that wording also needs alignment.

Suggested improvement:

  • Explain that training creates a local model file, and uploading/submitting is a separate step.
  • Update the old function name and related descriptions in the guide and service comments.
  • Keep this focused on documentation, without changing how the commands work.
Linguagem predominante
Python
Estrelas
4
Forks
7
Merge médio
3d 7h
PRs com merge (30d)
33

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de InfiniteZeroFoundation/DevNet

Todas as issues de InfiniteZeroFoundation/DevNet

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.