AI4OPT/ML4OPF

Add documentation for PGLearn

Offen

#34 geöffnet am 16.02.2025

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (11 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (33 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

The docs should have some tutorial for how to download and use PGLearn in ML4OPF.

Basic usage is explained in #46

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandene Codebasis und Issue #46, um die grundlegende Verwendung von PGLearn zu verstehen. Erstellen Sie ein Tutorial Dokument mit Schritt für Schritt Anleitungen zum Herunterladen, Installieren und Verwenden von PGLearn im ML4OPF Framework.
Tech Stack
pythonpytorch
Domain
machine learning
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70