genai latex proofreader herunterladen - genai latex proofreader Quellcode herunterladen

genai latex proofreader

AI-Quellcode

1.0.0

Herunterladen

GenAI LaTeX-Korrekturleser

GenAI LaTeX Proofreader ist ein automatisiertes Tool, das generative KI nutzt, um in LaTeX verfasste wissenschaftliche Arbeiten Korrektur zu lesen und Verbesserungen vorzuschlagen. Die Vorschläge werden in die ursprüngliche LaTeX-Quelldatei eingefügt, wodurch ein Korrekturlesebericht erstellt wird. Dieses Tool richtet sich in erster Linie an Autoren, die an einer wissenschaftlichen Arbeit arbeiten.

Genauer gesagt enthält der erstellte Korrekturlesebericht die zu prüfende Originalarbeit sowie eine Liste mit Vorschlägen am Anfang jedes Abschnitts. Für jeden Abschnitt wird Feedback aus der Perspektive verschiedener Korrektorpersonen erstellt. Beim Verfassen einer Arbeit könnten dies beispielsweise „Domänenexperte“, „Experte für englische Sprache“ und „Buchredakteur“ sein. Allerdings können die Personas je nach Thema der Arbeit auch weitere Personas wie „Statistischer Gutachter“, „LaTeX-Spezialist“ oder „Inklusiver Sprachexperte“ usw. umfassen.

Dabei ist „Korrekturlesen“ weit zu interpretieren. Während aktuelle Large Language Models (LLMs) über Kenntnisse in Logik, Mathematik und Physik verfügen, sollte man sich LLMs nicht für das ernsthafte Korrekturlesen wissenschaftlicher Ergebnisse anvertrauen. Daher sollten alle Vorschläge kritisch bewertet werden. Andererseits kann der erstellte Bericht für Autoren, die mit einem Thema vertraut sind, dazu verwendet werden, zu beurteilen, wie tiefgreifend ein LLM über die zu begutachtende Arbeit nachdenken kann.

GenAI LaTeX Proofreader erfordert ein Abonnement der Anthropic API.

Beispiele für Korrekturleseberichte

Zu Entwicklungs- und Testzwecken wird GenAI LaTeX Proofreader regelmäßig durch Korrekturlesen von zwei Testarbeiten evaluiert:

ein leeres Papier: ein Papier ohne Substanz.
arxiv:1108.4207: ein Vorabdruck einer meiner früheren Arbeiten.

Genauer gesagt werden diese Dokumente für alle manuell ausgelösten CI-Läufe in diesem Repo Korrektur gelesen. So können Sie die generierten Korrekturleseberichte ( report.pdf ) aus den letzten CI-Pipeline-Läufen auf Github einsehen:

Beispiel-CI-Lauf 2024.06.30
alle Läufe mit generierten Berichten
Hinweis: Zum Herunterladen der generierten Berichte müssen Sie bei Github angemeldet sein.

Merkmale

Vollständig automatisiertes Korrekturlesen von LaTeX-Dokumenten.

Um einen Korrekturlesebericht zu erstellen, muss man lediglich ein Python-Skript ausführen, das Aufrufe an eine GenAI-API durchführt und automatisch einen Korrekturlesebericht generiert. Die Kommentare werden automatisch in die LaTeX-Eingabedatei eingefügt und zu einem PDF kompiliert.
Wenn die Arbeit beispielsweise in GitHub unter Versionskontrolle steht, kann man GitHub-Runner verwenden, um automatisch einen Korrekturlesebericht zu erstellen, wann immer eine neue Version der Arbeit eingecheckt wird.

Unterstützte Korrekturlese-Personas

✅ Domain-Experte (implementiert)

Bewerten Sie jeden Abschnitt kritisch auf Richtigkeit und Klarheit. Identifizieren Sie Stärken und Schwächen und geben Sie Vorschläge für die zukünftige Arbeit.
Bewerten Sie außerdem, wie gut Titel, Zusammenfassung und Einleitung zum Inhalt der restlichen Arbeit passen.
Umsetzung mit Hinweisen hier.

✅ Sprachexperte (implementiert)

Lesen Sie den Inhalt auf Tippfehler, Wortlaut, Grammatik und Ablauf Korrektur.
Umsetzung mit Hinweisen hier.

? Bucheditor (noch nicht implementiert)

Bewerten Sie die übergeordnete Organisation des Papiers.

? LaTeX-Spezialist (noch nicht implementiert)

Geben Sie Feedback zu Ihrer Verwendung von LaTeX.

? Peer-Review für Zeitschrift (noch nicht implementiert)

Siehe https://arxiv.org/abs/2310.01783 in den Referenzen unten.

? Benutzerdefinierte Personas für das Korrekturlesen

Zusätzlich zu den oben genannten können weitere Korrekturlesepersonen hinzugefügt werden. Allerdings erfordert dies derzeit, dass man den Python-Quellcode bearbeitet.

Die Idee, verschiedene KI-Personas für das Korrekturlesen zu verwenden, ist inspiriert von Ethan Mollicks Buch Co-Intelligence: Living and Working with AI, erschienen 4/2024.

Einschränkungen

Für die Arbeit wird eine gewisse Struktur vorausgesetzt. Z.B
- Inhalte vor dem ersten section{..} werden nicht Korrektur gelesen.
- Nicht nummerierte Abschnitte werden nicht unterstützt section*{..} .
- Der Inhalt der enthaltenen Dateien ist für den Korrekturleser nicht sichtbar.
Die GenAI wird keine Bilder oder Referenzen sehen oder verstehen.
Der Korrekturlesebericht ist nicht deterministisch. Verschiedene Läufe mit demselben Eingabedokument können unterschiedliche Berichte generieren.
Es gibt mehrere Anbieter, die Zugriff auf LLMs anbieten, wie OpenAI, Anthropic, Google. Derzeit wird nur Anthropic unterstützt.
Ihre Arbeit wird über das Internet an den LLM-Anbieter gesendet. Bitte lesen Sie die Nutzungsbedingungen sorgfältig durch.
Auch die Verwendung von LLMs verursacht einige Kosten.
Verwendet pdflatex und TexLive. TexLive wird auch von arxiv verwendet, Link.
Die vom bereitgestellten LLM zurückgegebenen Korrekturlesekommentare enthalten in einigen Fällen LaTeX-Fehler. GenAI LaTeX Proofreader wird versuchen, diese zu beheben. In einigen Fällen kann es jedoch vorkommen, dass der Korrekturlesebericht nicht erstellt werden kann.

Erste Schritte

Beachten Sie, dass es sich bei dieser Arbeit um einen frühen Proof of Concept handelt, sodass möglicherweise eine gewisse Vertrautheit mit den Entwicklungstools (Git, Python, Docker, Anthropic API-Zugriff) erforderlich ist, damit dies funktioniert.

Die folgenden Schritte (für Mac-/Linux-basierte Systeme) beschreiben, wie Sie eine Arbeit Korrektur lesen:

Schritt 1: Klonen Sie das Repo

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

Schritt 2: Erstellen Sie den Docker-Container (mit Python und Latex)

(cd .devcontainer/latex ; make build)

Schritt 3: Richten Sie einen geheimen Token für die Anthropic API ein, siehe https://docs.anthropic.com/en/docs/quickstart

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

(Hinweis: Geben Sie Ihren ANTHROPIC_API_KEY nicht weiter.)

Schritt 4: Kopieren Sie die zum Erstellen Ihrer Arbeit erforderlichen Dateien in das Unterverzeichnis „paper-to-proofread“ im Repo.

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

Zum Testen können Sie ein im Repository bereitgestelltes Dummy-Papier tests/integration/assets/empty_paper.tex verwenden.

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

(Hinweis: Bitte halten Sie immer eine Sicherungskopie Ihrer Arbeit bereit.)

Schritt 5: Führen Sie genai-latex-proofreader aus

(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)

Bei mittelgroßem Papier dauert dies einige Minuten. Wenn alles funktioniert hat, finden Sie den Korrekturlesebericht in output/report.pdf .

Konfiguration und Anpassung

Abhängig vom Thema Ihrer Arbeit möchten Sie möglicherweise die Eingabeaufforderungen anpassen, die die Korrekturlese-Personas definieren. Derzeit müssen die Eingabeaufforderungen direkt im Python-Quellcode bearbeitet werden.

Generative KI

GenAI LaTeX Proofreader nutzt GenAI (Generative AI) und große Sprachmodelle (LLM), um das Korrekturlesen wissenschaftlicher Arbeiten zu automatisieren. Ab 2024 ist GenAI eine sich schnell entwickelnde Technologie mit rasanten Entwicklungen.

Die folgende Liste enthält einige Referenzen und verwandte Arbeiten zu diesem Thema und allgemeiner zum Einsatz von KI für wissenschaftliche Entdeckungen:

12/2023, Microsoft Research, The Impact of Large Language Models on Scientific Discovery: a Preliminary Study using GPT-4
- https://arxiv.org/pdf/2311.07361
10/2023, W. Liang et al., Können große Sprachmodelle nützliches Feedback zu Forschungsarbeiten geben? Eine groß angelegte empirische Analyse
- https://arxiv.org/abs/2310.01783
- https://github.com/Weixin-Liang/LLM-scientific-feedback
6/2023, KI zur Unterstützung des mathematischen Denkens: Ein von den National Academies of Sciences organisierter Workshop .
- https://www.nationalacademies.org/event/06-12-2023/ai-to-assist-mathematical-reasoning-a-workshop
- Sammlung von Ressourcen, die im Rahmen des Workshops gesammelt wurden: https://docs.google.com/document/d/1kD7H4E28656ua8jOGZ934nbH2HcBLyxcRgFDduH5iQ0/edit

Beiträge

Beiträge, Feedback oder Ideen sind willkommen!

Sie können mich gerne kontaktieren oder ein Problem in diesem Repo ansprechen.

FAQ

Muss ich diese Arbeit zitieren, wenn ich sie für eine Arbeit verwende?

(Diese Frage liegt außerhalb meines Fachgebiets.)

Die Richtlinien und Praktiken rund um die Verwendung von KI-Inhalten entwickeln sich noch weiter. Für die Veröffentlichung von Arbeiten im akademischen Umfeld wenden Sie sich jedoch bitte zunächst an Ihren Betreuer, Ihre Abteilung, Ihre Zeitschrift und/oder Ihre Universität.

Bitte beachten Sie auch Folgendes:

KI-generierter Text kann Teile wörtlich aus seinen Trainingsdaten reproduzieren.
Eventuell können LLM-Anbieter auch Nutzungseinschränkungen vorsehen.
GenAI LaTeX Proofreader wird unter den Bedingungen der MIT-Lizenz vertrieben, Einzelheiten siehe unten. Diese Lizenz legt nur sehr wenige Einschränkungen hinsichtlich der Nutzung dieser Software fest, und für die normale Nutzung ist keine Quellenangabe erforderlich.