GridFM

Train, finetune and interact with a foundation model for the electric power grid.
https://github.com/gridfm/gridfm-graphkit

Category: Energy Systems
Sub Category: Grid Analysis and Planning

Last synced: about 11 hours ago
JSON representation

Repository metadata

Train, finetune and interact with a foundation model for the electric power grid.

Host: GitHub
URL: https://github.com/gridfm/gridfm-graphkit
Owner: gridfm
License: apache-2.0
Created: 2025-06-23T14:51:29.000Z (7 months ago)
Default Branch: main
Last Pushed: 2025-12-19T13:49:20.000Z (23 days ago)
Last Synced: 2025-12-30T03:40:58.517Z (13 days ago)
Language: Python
Homepage: https://gridfm.github.io/gridfm-graphkit/
Size: 139 MB
Stars: 51
Watchers: 0
Forks: 8
Open Issues: 6
Releases: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

README.md

This library is brought to you by the GridFM team to train, finetune and interact with a foundation model for the electric power grid.

Installation

You can install gridfm-graphkit directly from PyPI:

pip install gridfm-graphkit

To contribute or develop locally, clone the repository and install in editable mode:

git clone git@github.com:gridfm/gridfm-graphkit.git
cd gridfm-graphkit
python -m venv venv
source venv/bin/activate
pip install -e .

For documentation generation and unit testing, install with the optional dev and test extras:

pip install -e .[dev,test]

CLI commands

An interface to train, fine-tune, and evaluate GridFM models using configurable YAML files and MLflow tracking.

gridfm_graphkit <command> [OPTIONS]

Available commands:

train – Train a new model from scrathc
finetune – Fine-tune an existing pre-trained model
evaluate – Evaluate model performance on a dataset
predict – Run inference and save predictions

Training Models

gridfm_graphkit train --config path/to/config.yaml

Arguments

Argument	Type	Description	Default
`--config`	`str`	Required. Path to the training configuration YAML file.	`None`
`--exp_name`	`str`	Optional. MLflow experiment name.	`timestamp`
`--run_name`	`str`	Optional. MLflow run name.	`run`
`--log_dir`	`str`	Optional. MLflow logging directory.	`mlruns`
`--data_path`	`str`	Optional. Root dataset directory.	`data`

Examples

Standard Training:

gridfm_graphkit train --config examples/config/case30_ieee_base.yaml --data_path examples/data

Fine-Tuning Models

gridfm_graphkit finetune --config path/to/config.yaml --model_path path/to/model.pth

Arguments

Argument	Type	Description	Default
`--config`	`str`	Required. Fine-tuning configuration file.	`None`
`--model_path`	`str`	Required. Path to a pre-trained model file.	`None`
`--exp_name`	`str`	MLflow experiment name.	timestamp
`--run_name`	`str`	MLflow run name.	`run`
`--log_dir`	`str`	MLflow logging directory.	`mlruns`
`--data_path`	`str`	Root dataset directory.	`data`

Evaluating Models

gridfm_graphkit evaluate --config path/to/eval.yaml --model_path path/to/model.pth

Arguments

Argument	Type	Description	Default
`--config`	`str`	Required. Path to evaluation config.	`None`
`--model_path`	`str`	Path to the trained model file.	`None`
`--exp_name`	`str`	MLflow experiment name.	timestamp
`--run_name`	`str`	MLflow run name.	`run`
`--log_dir`	`str`	MLflow logging directory.	`mlruns`
`--data_path`	`str`	Dataset directory.	`data`

Running Predictions

gridfm_graphkit predict --config path/to/config.yaml --model_path path/to/model.pth

Arguments

Argument	Type	Description	Default
`--config`	`str`	Required. Path to prediction config file.	`None`
`--model_path`	`str`	Path to the trained model file.	`None`
`--exp_name`	`str`	MLflow experiment name.	timestamp
`--run_name`	`str`	MLflow run name.	`run`
`--log_dir`	`str`	MLflow logging directory.	`mlruns`
`--data_path`	`str`	Dataset directory.	`data`
`--output_path`	`str`	Directory where predictions are saved.	`data`

Owner metadata

Name: gridfm
Login: gridfm
Email:
Kind: organization
Description:
Website:
Location:
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/12138362?v=4
Repositories: 1
Last ynced at: 2023-03-01T14:30:36.533Z
Profile URL: https://github.com/gridfm

GitHub Events

Total

Create event: 20
Issues event: 5
Release event: 4
Watch event: 23
Delete event: 9
Issue comment event: 1
Member event: 3
Push event: 44
Pull request review comment event: 3
Pull request review event: 5
Pull request event: 12
Fork event: 4

Last Year

Create event: 20
Issues event: 5
Release event: 4
Watch event: 23
Delete event: 9
Issue comment event: 1
Member event: 3
Push event: 44
Pull request review comment event: 3
Pull request review event: 5
Pull request event: 12
Fork event: 4

Committers metadata

Last synced: 1 day ago

Total Commits: 78
Total Committers: 8
Avg Commits per committer: 9.75
Development Distribution Score (DDS): 0.538

Commits in past year: 69
Committers in past year: 7
Avg Commits per committer in past year: 9.857
Development Distribution Score (DDS) in past year: 0.478

Name	Email	Commits
MatteoMazzonelli	m**1@i**m	36
Matteo Mazzonelli	M**i@i**m	12
Mangaliso Mngomomezulu	6****M	10
Celia Cintas	c**s@i**m	8
Alban Puech	A**1@i**m	6
“Mangaliso-M”	“**u@g**”	4
Jonas Weiss	J**E@z**m	1
Etienne Eben Vos	E**s@i**m	1

Committer domains:

Issue and Pull Request metadata

Last synced: 3 days ago

Total issues: 2
Total pull requests: 14
Average time to close issues: about 2 months
Average time to close pull requests: 1 day
Total issue authors: 2
Total pull request authors: 5
Average comments per issue: 0.5
Average comments per pull request: 0.07
Merged pull request: 8
Bot issues: 0
Bot pull requests: 0

Past year issues: 2
Past year pull requests: 14
Past year average time to close issues: about 2 months
Past year average time to close pull requests: 1 day
Past year issue authors: 2
Past year pull request authors: 5
Past year average comments per issue: 0.5
Past year average comments per pull request: 0.07
Past year merged pull request: 8
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/gridfm/gridfm-graphkit

Top Issue Authors

TavoIREQ (1)
mellson (1)

Top Pull Request Authors

MatteoMazzonelli (8)
ttolhurst (3)
celiacintas (1)
naomi-simumba (1)
Mangaliso-M (1)

Top Issue Labels

bug (1)

Top Pull Request Labels

enhancement (4)
documentation (2)

Package metadata

Total packages: 1
Total downloads:
- pypi: 53 last-month
Total dependent packages: 0
Total dependent repositories: 0
Total versions: 7
Total maintainers: 1

pypi.org: gridfm-graphkit

Grid Foundation Model

Homepage:
Documentation: https://gridfm-graphkit.readthedocs.io/
Licenses: apache-2.0
Latest release: 0.0.6 (published 4 months ago)
Last Synced: 2026-01-09T21:25:07.482Z (2 days ago)
Versions: 7
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 53 Last month
Rankings:
- Dependent packages count: 8.944%
- Average: 29.672%
- Dependent repos count: 50.399%
Maintainers (1)
- ccintas

Dependencies

.github/workflows/ci-build.yaml actions

actions/checkout v4 composite
actions/setup-python v4 composite

.github/workflows/deploy_docs.yaml actions

actions/cache v4 composite
actions/checkout v4 composite
actions/setup-python v4 composite

pyproject.toml pypi

mlflow >=3.1.0
nbformat >=5.10.4
networkx >=3.4.2
numpy >=2.2.6
pandas >=2.3.0
plotly >=6.1.2
pyyaml >=6.0.2
torch >=2.7.1
torch-geometric >=2.6.1
torchaudio >=2.7.1
torchvision >=0.22.1

.github/workflows/release.yaml actions

actions/checkout v4 composite
actions/setup-python v4 composite
pypa/gh-action-pypi-publish release/v1 composite

Score: 10.11147685607866

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

GridFM

Repository metadata

README.md

Installation

CLI commands

Training Models

Arguments

Examples

Fine-Tuning Models

Arguments

Evaluating Models

Arguments

Running Predictions

Arguments

Owner metadata

GitHub Events

Total

Last Year

Committers metadata

Committer domains:

Issue and Pull Request metadata

Top Issue Authors

Top Pull Request Authors

Top Issue Labels

Top Pull Request Labels

Package metadata

pypi.org: gridfm-graphkit

Dependencies