AI4OPT/ML4OPF

Add documentation for PGLearn

Open

#34 opened on Feb 16, 2025

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (11 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (33 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Basic usage is explained in #46

Contributor guide

Research direction
Review the existing codebase and issue #46 to understand the basic usage of PGLearn. Create a tutorial document with step by step instructions for downloading, installing, and using PGLearn in the ML4OPF framework.
Tech stack
pythonpytorch
Domain
machine learning
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70