Skip to main content

Transformer based foundation model for galaxy images (and general astronomy)

Project description

astroPT_shoggoth

PyPI PyPI Downloads docs License: AGPL-v3 All Contributors

ICML arXiv arXiv

Model on HF Dataset on HF

AstroPT: a Large Observation (foundation) Model for astronomy 🔭

Welcome to our simple repository for training astronomical large observation models. This repository began its life as Andrej Karpathy's nanoGPT, and has been altered so that it is usable for astronomical observation data. Within train.py you will find a ~300-line boilerplate training loop and within model.py you will find a ~300-line GPT model definition with an MLP tokeniser and a regressive loss.

Check out the UniverseTBD Discord for updates: discord.gg/MNEVegvfJq

Read the docs here: astropt.readthedocs.io

How does AstroPT work?

AstroPT is an autoregressive transformer under the hood.

Similarly to language models that predict the next word in a sentence, AstroPT processes sequences of astronomical data chunks to predict what comes next.

The intuition here is that this next-token-prediction task requires the model to internalise some understanding of the physical processes underlying the training data.

This is just like how a text GPT needs to have some knowledge of geography to guess a country's capital given a description of that country, or some knowledge of coding to write compilable Fortran.

Below we can see this principle applied to a galaxy image, where we split the image into chunks and pass them into an AstroPT model:

galaxy_im    astroPT_arch  

Of course we can apply this next-token-prediction task across many modalities due to its flexibility.

Check out our work on Euclid data for an example, where we chain galaxy image tokens and spectral energy distribution data and pass them into a single, unified AstroPT model.

I just want to run it! 🗣️

Okay I hear you! First you need to install the model:

Install

You can install via pip from PyPI:

pip install astropt

Or if you install locally via a git clone, you can uv install via:

git clone https://github.com/Smith42/astroPT.git
cd astroPT
uv sync

Load a pre-trained model

To load and run a pre-trained AstroPT model from HuggingFace you can use the load_astropt function:

from astropt.model_utils import load_astropt

model = load_astropt(
    repo_id="smith42/astropt_v2.0",
    path="astropt/095M",
    weights_filename="ckpt.pt",
)
model = model.to("cuda")

where repo_id is the HuggingFace repository ID, and path is the path within the repository that contains the AstroPT model checkpoint.

Pre-trained models

Below are some pre-trained models you can load with the code snippet above. Please make sure that you are using the correct version of AstroPT to load these!

Survey Modalities AstroPT version Model weights Dataset Paper
DESI Legacy Survey JPG galaxy imagery v1.0.0 AstroPT Galaxies Dataset arXiv:2405.14930
Euclid FITS VIS, NISP galaxy imagery and SED data v1.0.2 AstroPT-Euclid Euclid Training Dataset arXiv:2503.15312
DESI Legacy Survey JPG galaxy imagery v2.0.5 AstroPT v2.0 Galaxies Dataset v2.0 arXiv:2405.14930

Scripts for pre-training and processing data

Check out scripts for a collection of all the scripts we have used to get the results in these papers, and scripts/train.py for an example boilerplate script for pre-training your own AstroPT. config contains example user configurations for pre-training.

scripts/linear_probe.py has an example script for inferring embeddings from a pre-trained model and running a finetuning routine on them 🌝.

And finally scripts/finetune.py has an example LoRA finetune routine.

Contributors

Ryan Roberts
Ryan Roberts

💻 🤔 🖋
Mike Smith
Mike Smith

💻 🤔 🖋 🔣
mhuertascompany
mhuertascompany

🤔 🖋
Malgorzata Siudek
Malgorzata Siudek

🤔 🖋 💻 🔣
gimarso
gimarso

🤔 💻
Add your contributions

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

astropt-2.0.7.dev0.tar.gz (61.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

astropt-2.0.7.dev0-py3-none-any.whl (29.7 kB view details)

Uploaded Python 3

File details

Details for the file astropt-2.0.7.dev0.tar.gz.

File metadata

  • Download URL: astropt-2.0.7.dev0.tar.gz
  • Upload date:
  • Size: 61.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.4

File hashes

Hashes for astropt-2.0.7.dev0.tar.gz
Algorithm Hash digest
SHA256 196099e5781daa3672ec93f10af9ad702a02d59217b1d9d5727673acd97b0198
MD5 3c5f8a495358f6e1c1e2d16061c5f71e
BLAKE2b-256 7cb2c4d1a89b1a17cf47e3b08ae051509a6806b79281b03575dbcc05da3b9d21

See more details on using hashes here.

File details

Details for the file astropt-2.0.7.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for astropt-2.0.7.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 483abdeed0924fedf34e48d37c625ef521e01790fd0c367c32ffc87fcb2a84c9
MD5 20dfab466568a60ea672e07221064f46
BLAKE2b-256 6f9cf9b70d304c57789b6b6e68b5842437494f1c083df0d0bfc86b2f38aca51f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page