genai latex proofreader Download - genai latex proofreader Download do código-fonte

genai latex proofreader

Código-Fonte de IA

1.0.0

Baixar

Revisor GenAI LaTeX

GenAI LaTeX Proofreader é uma ferramenta automatizada que usa IA generativa para revisar e sugerir melhorias em artigos científicos escritos em LaTeX. As sugestões são anexadas ao arquivo fonte LaTeX original, criando um relatório de revisão. Esta ferramenta destina-se principalmente a autores que trabalham em um artigo científico.

Mais detalhadamente, o relatório de revisão gerado contém o artigo original em revisão, com uma lista de sugestões anexada ao início de cada seção. Para cada seção, o feedback é criado a partir da perspectiva de diferentes revisores. Por exemplo, ao escrever um artigo, podem ser "Especialista em domínio", "Especialista em língua inglesa" e "Editor de livro". No entanto, as personas também podem incluir personas adicionais, como "Revisor estatístico", "Especialista em LaTeX" ou "Especialista em linguagem inclusiva", etc., dependendo do tópico do artigo.

Aqui, a “revisão” deve ser interpretada de forma ampla. Embora os atuais modelos de grandes linguagens (LLMs) tenham uma compreensão de lógica, matemática e física, os LLMs não devem ser confiáveis para uma revisão séria de resultados científicos. Assim, quaisquer sugestões devem ser avaliadas criticamente. Por outro lado, para autores familiarizados com um tema, o relatório gerado pode ser usado para avaliar o quão profundamente um LLM pode raciocinar sobre o artigo em revisão.

GenAI LaTeX Proofreader requer uma assinatura da API Antrópica.

Exemplos de relatórios de revisão

Para desenvolvimento e teste, o GenAI LaTeX Proofreader é regularmente avaliado pela revisão de dois papéis de teste:

um papel vazio: um papel sem substância.
arxiv:1108.4207: uma pré-impressão de um de meus artigos anteriores.

Mais detalhadamente, esses documentos são revisados para todas as execuções de CI acionadas manualmente neste repositório. Assim, você pode inspecionar os relatórios de revisão gerados ( report.pdf ) de execuções recentes do pipeline de CI no Github:

exemplo de execução de CI 2024.06.30
todas as execuções com relatórios gerados
Observação: o download dos relatórios gerados requer que você esteja logado no Github.

Características

Revisão totalmente automatizada de documentos LaTeX.

Para criar um relatório de revisão, basta executar um script Python, que fará chamadas para uma API GenAI e gerará automaticamente um relatório de revisão. Os comentários são inseridos automaticamente no arquivo LaTeX de entrada e compilados em um pdf.
Por exemplo, se o artigo estiver sob controle de versão no GitHub, pode-se usar os executores do GitHub para gerar automaticamente um relatório de revisão sempre que uma nova versão do artigo for registrada.

Personas de revisão suportadas

✅ Especialista em domínio (implementado)

Avalie criticamente cada seção quanto à correção e clareza. Identifique pontos fortes e fracos e forneça sugestões para trabalhos futuros.
Avalie também até que ponto o título, o resumo e a introdução correspondem ao conteúdo do restante do artigo.
Implementação com prompts aqui.

✅ Especialista em idiomas (implementado)

Revise o conteúdo quanto a erros de digitação, redação, gramática e fluxo.
Implementação com prompts aqui.

? Editor de livros (ainda não implementado)

Avalie a organização de alto nível do artigo.

? Especialista em LaTeX (ainda não implementado)

Dê feedback sobre seu uso do LaTeX.

? Revisão por pares para periódico (ainda não implementada)

Consulte https://arxiv.org/abs/2310.01783 nas referências abaixo.

? Personas de revisão personalizadas

Além do acima, pode-se adicionar outras personas de revisão. No entanto, isso atualmente requer que se edite o código-fonte do Python.

A ideia de usar diferentes personas de IA para revisão é inspirada no livro de Ethan Mollick, Co-Inteligência: Vivendo e trabalhando com IA, publicado em 4/2024.

Limitações

Alguma estrutura é assumida para o artigo. Por exemplo
- O conteúdo antes da primeira section{..} não será revisado.
- Seções não numeradas não são suportadas section*{..} .
- O conteúdo de quaisquer arquivos incluídos não ficará visível para o revisor.
O GenAI não verá nem compreenderá quaisquer imagens ou referências.
O relatório de revisão não será determinístico. Diferentes execuções com o mesmo documento de entrada podem gerar relatórios diferentes.
Existem vários provedores que oferecem acesso a LLMs, como OpenAI, Anthropic, Google. Atualmente apenas o Antrópico é suportado.
Seu artigo será enviado pela internet para o provedor LLM. Por favor, leia atentamente os termos de serviço.
O uso de LLMs também acarretará alguns custos.
Usa pdflatex e TexLive. TexLive também é usado pelo arxiv, link.
Os comentários de revisão retornados pelo LLM fornecido incluirão, em alguns casos, erros de LaTeX. GenAI LaTeX Proofreader tentará consertar isso. No entanto, em alguns casos, o relatório de revisão pode não ser compilado.

Começando

Observe que este trabalho é uma prova inicial de conceito, portanto, pode ser necessária alguma familiaridade com as ferramentas de desenvolvimento (git, Python, Docker, acesso à API Anthropic) para que isso funcione.

As etapas abaixo (para sistemas baseados em Mac/Linux) descrevem como revisar um artigo:

Etapa 1: clonar o repositório

git clone [email protected]:genai-latex-proofreader/genai-latex-proofreader.git
cd genai-latex-proofreader

Etapa 2: construir o contêiner Docker (com Python e Latex)

(cd .devcontainer/latex ; make build)

Etapa 3: Configure o token secreto para a API Anthropic, consulte https://docs.anthropic.com/en/docs/quickstart

 export ANTHROPIC_API_KEY= ' your-secret-api-key-here '

(Observação: não compartilhe seu ANTHROPIC_API_KEY )

Etapa 4: Copie os arquivos necessários para criar seu artigo no subdiretório ‘paper-to-proofread’ do repositório.

mkdir paper-to-proofread
cp -R /path/to/your/paper/. paper-to-proofread

Para testar, você pode usar um documento fictício tests/integration/assets/empty_paper.tex fornecido no repositório.

mkdir paper-to-proofread
cp -R tests/integration/assets/. paper-to-proofread/

(Observação: sempre tenha um backup do seu documento.)

Etapa 5: execute genai-latex-proofreader

(cd .devcontainer/latex ; docker compose run --rm --entrypoint " python3 " genai-latex-proofreader-service -m genai_latex_proofreader.cli --input_latex_path paper-to-proofread/empty_paper.tex --output_report_filepath output/report.tex)

Para um papel de tamanho médio, isso levará alguns minutos. Se tudo funcionou, o relatório de revisão pode ser encontrado em output/report.pdf .

Configuração e personalização

Dependendo do tópico do seu artigo, você pode querer ajustar as instruções que definem as personas da revisão. Atualmente os prompts precisam ser editados diretamente no código-fonte do Python.

IA generativa

GenAI LaTeX Proofreader usa GenAI (Generative AI) e grandes modelos de linguagem (LLM) para automatizar a revisão de artigos científicos. A partir de 2024, GenAI é uma tecnologia em rápida evolução com desenvolvimentos rápidos.

A lista abaixo contém algumas referências e trabalhos relacionados sobre este tópico e, de forma mais ampla, sobre o uso de IA para fazer descobertas científicas:

12/2023, Microsoft Research, O Impacto de Grandes Modelos de Linguagem na Descoberta Científica: um Estudo Preliminar usando GPT-4
- https://arxiv.org/pdf/2311.07361
10/2023, W. Liang et al., Grandes modelos de linguagem podem fornecer feedback útil sobre artigos de pesquisa? Uma análise empírica em grande escala
- https://arxiv.org/abs/2310.01783
- https://github.com/Weixin-Liang/LLM-scientific-feedback
6/2023, IA para auxiliar o raciocínio matemático: um workshop organizado pelas Academias Nacionais de Ciências.
- https://www.nationalacademies.org/event/06-12-2023/ai-to-assist-mathematical-reasoning-a-workshop
- Coleção de recursos coletados como parte do workshop: https://docs.google.com/document/d/1kD7H4E28656ua8jOGZ934nbH2HcBLyxcRgFDduH5iQ0/edit

Contribuições

Contribuições, comentários ou ideias são bem-vindos!

Sinta-se à vontade para entrar em contato comigo ou levantar um problema neste repositório.

Perguntas frequentes

Preciso citar este trabalho se eu usá-lo em um artigo?

(Esta questão está fora da minha área de especialização.)

As diretrizes e práticas relacionadas ao uso de conteúdo de IA ainda estão evoluindo. No entanto, para publicar trabalhos em ambiente acadêmico, consulte primeiro seu orientador, departamento, periódico e/ou universidade.

Observe também que:

O texto gerado pela IA pode reproduzir partes literalmente de seus dados de treinamento.
Os provedores de LLM também podem impor restrições ao uso.
GenAI LaTeX Proofreader é distribuído sob os termos da licença MIT, veja os detalhes abaixo. Esta licença impõe poucas restrições sobre como este software pode ser usado e, para uso normal, a licença não requer citação.