rsdiff 0.1.0__tar.gz

rsdiff-0.1.0/.gitignore

@@ -0,0 +1,50 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+/build/
+/dist/
+.venv/
+.venv-*/
+venv/
+.eggs/
+
+# Data, weights, logs (repo-root only; never match package modules such as src/rsdiff/datasets)
+/data/
+/datasets/
+/checkpoints/
+/runs/
+/logs/
+/outputs/
+/generated/
+/ddpm/ckpts/
+/ddpm/logs/
+wandb/
+*.pt
+*.safetensors
+*.ckpt
+*.bin
+
+# Editor / OS / tool caches
+.idea/
+.vscode/
+.DS_Store
+.ruff_cache/
+.mypy_cache/
+.pytest_cache/
+.serena/
+.ipynb_checkpoints/
+
+# Secrets and per-machine state
+.env
+.env.local
+.vast/
+secrets/
+.claude/settings.local.json
+.claude/.memory/
+
+# mkdocs build output
+/docs/site/site/
+/docs/site/site_out/
+
+# Private notes (drafts, roadmap, lit reviews)
+.notes/

rsdiff-0.1.0/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## 0.1.0
+
+First PyPI release. The package now samples and scores the released `rsdiff1.5` cascade
+instead of raising `NotImplementedError`.
+
+- `rsdiff sample --prompt "..."` downloads the released checkpoint
+  (`asebaq/rsdiff-sr-cascade-ep650`, pinned revision, SHA-256 verified) and writes 256×256
+  PNGs plus `captions.txt`. `--rsicd ROOT` draws RSICD captions instead; with seed 17 and
+  the full test split they are the captions of the published bundle. Interrupted runs
+  resume. Every PNG carries the prompt and a synthetic-content notice in its text chunks.
+- `rsdiff eval fid` and `rsdiff eval clip` score a bundle with the published protocol.
+  On the published 1,093-image bundle they return FID 65.688 (released 65.698) and
+  CLIP-score 0.27771 (released 0.27771). FID must be scored against real images built by
+  `scripts/build_rsicd_csv.py --split-csv`; the original RSICD JPEGs give 70.15.
+- `rsdiff.cascade`, `rsdiff.config` (packaged `rsdiff1.5` and `rsdiff1` presets),
+  `rsdiff.eval` and `rsdiff.datasets` form the Python API.
+- Sampling and FID run on CUDA or CPU. Apple MPS is not used: imagen-pytorch 2.1.0 and
+  torchmetrics' FID need float64.
+- Removed the unused `diffusers` scaffold (`rsdiff train`, `rsdiff.models`,
+  `rsdiff.pipelines`, `rsdiff.conditioning`, `zeroshot_oa`) and its dependencies.
+  Training remains in `ddpm/` until the packaged sampler's metrics match it.
+- Corrected the documented metric protocol: the headline FID uses torchmetrics'
+  `FrechetInceptionDistance` (feature 2048), not clean-fid.
+- The commercial monitoring experiments moved to a separate repository.

rsdiff-0.1.0/CITATION.cff

@@ -0,0 +1,37 @@
+cff-version: 1.2.0
+title: "RSDiff: remote sensing image generation from text"
+version: 0.1.0
+message: >-
+  If you use this software or the reproduction results, please cite both the
+  published paper (preferred) and this repository.
+type: software
+authors:
+  - family-names: Sebaq
+    given-names: Ahmad
+    email: ahmad.sebaq@gmail.com
+repository-code: "https://github.com/asebaq/rsdiff"
+url: "https://asebaq.github.io/rsdiff"
+license: Apache-2.0
+keywords:
+  - diffusion models
+  - text-to-image
+  - remote sensing
+  - satellite imagery
+  - RSICD
+  - cascaded diffusion
+  - generative models
+preferred-citation:
+  type: article
+  title: "RSDiff: remote sensing image generation from text using diffusion model"
+  authors:
+    - family-names: Sebaq
+      given-names: Ahmad
+    - family-names: ElHelw
+      given-names: Mohamed
+  journal: "Neural Computing and Applications"
+  volume: 36
+  issue: 36
+  start: 23103
+  end: 23111
+  year: 2024
+  doi: "10.1007/s00521-024-10363-3"

rsdiff-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

rsdiff-0.1.0/NOTICE

@@ -0,0 +1,23 @@
+RSDiff
+Copyright 2026 Ahmad Sebaq
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE). The license
+covers the code in this repository only.
+
+Third-party components used at runtime, not distributed with RSDiff:
+
+- imagen-pytorch (https://github.com/lucidrains/imagen-pytorch), MIT License. RSDiff's
+  cascade is built from its Unet, Imagen and ImagenTrainer classes.
+- T5-base text encoder and tokenizer (https://huggingface.co/google-t5/t5-base),
+  Apache License 2.0, downloaded from the Hugging Face Hub on first use.
+- OpenAI CLIP ViT-B/32 (https://huggingface.co/openai/clip-vit-base-patch32), MIT License,
+  used only for evaluation.
+
+The released checkpoint (https://huggingface.co/asebaq/rsdiff-sr-cascade-ep650) was
+trained on the RSICD dataset (Lu et al., "Exploring Models and Data for Remote Sensing
+Image Caption Generation", IEEE TGRS 2018). No RSICD images or captions are distributed
+with this package. RSICD's terms for commercial use have not been established; see
+docs/LICENSE_AUDIT.md before using the checkpoint or its outputs commercially.
+
+Images produced by RSDiff are synthetic. They are not observations or predictions of any
+real location.

rsdiff-0.1.0/PKG-INFO

@@ -0,0 +1,245 @@
+Metadata-Version: 2.5
+Name: rsdiff
+Version: 0.1.0
+Summary: Text-to-satellite-image diffusion: the RSDiff cascade (NCAA 2024), released weights, and its FID/CLIP evaluation.
+Project-URL: Homepage, https://github.com/asebaq/rsdiff
+Project-URL: Documentation, https://asebaq.github.io/rsdiff
+Project-URL: Issues, https://github.com/asebaq/rsdiff/issues
+Project-URL: Changelog, https://github.com/asebaq/rsdiff/blob/main/CHANGELOG.md
+Project-URL: Paper, https://doi.org/10.1007/s00521-024-10363-3
+Project-URL: Weights, https://huggingface.co/asebaq/rsdiff-sr-cascade-ep650
+Author-email: Ahmad Sebaq <ahmad.sebaq@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: diffusion,imagen,remote-sensing,rsicd,satellite,text-to-image
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Requires-Python: >=3.10
+Requires-Dist: huggingface-hub>=0.25
+Requires-Dist: imagen-pytorch==2.1.0
+Requires-Dist: numpy>=1.26
+Requires-Dist: omegaconf>=2.3
+Requires-Dist: pandas>=2.2
+Requires-Dist: pillow>=10.4
+Requires-Dist: torch>=2.4
+Requires-Dist: torchvision>=0.19
+Requires-Dist: tqdm>=4.66
+Requires-Dist: transformers<5,>=4.44
+Provides-Extra: eval
+Requires-Dist: torchmetrics[image]>=1.4; extra == 'eval'
+Description-Content-Type: text/markdown
+
+<h1 align="center">
+  <a href="https://github.com/asebaq/rsdiff">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/asebaq/rsdiff/main/docs/assets/cover_dark.svg">
+      <img alt="rsdiff" src="https://raw.githubusercontent.com/asebaq/rsdiff/main/docs/assets/cover_light.svg" width="640">
+    </picture>
+  </a>
+</h1>
+
+<p align="center">
+  <a href="https://pypi.org/project/rsdiff/"><img alt="PyPI" src="https://img.shields.io/pypi/v/rsdiff?color=1D4ED8"></a>
+  <a href="https://pypi.org/project/rsdiff/"><img alt="Python" src="https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fasebaq%2Frsdiff%2Fmain%2Fpyproject.toml"></a>
+  <a href="https://github.com/asebaq/rsdiff/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/asebaq/rsdiff/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="https://github.com/asebaq/rsdiff/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/asebaq/rsdiff"></a>
+  <a href="https://doi.org/10.1007/s00521-024-10363-3"><img alt="DOI" src="https://img.shields.io/badge/DOI-10.1007%2Fs00521--024--10363--3-blue"></a>
+  <a href="https://huggingface.co/asebaq/rsdiff-sr-cascade-ep650"><img alt="Hugging Face model" src="https://img.shields.io/badge/Hugging%20Face-rsdiff--sr--cascade--ep650-yellow"></a>
+</p>
+
+<p align="center">
+  <a href="#install"><strong>Install</strong></a> &middot;
+  <a href="#use"><strong>Use</strong></a> &middot;
+  <a href="#results"><strong>Results</strong></a> &middot;
+  <a href="#how-it-works"><strong>How it works</strong></a> &middot;
+  <a href="#limitations"><strong>Limitations</strong></a> &middot;
+  <a href="#training"><strong>Training</strong></a> &middot;
+  <a href="#roadmap"><strong>Roadmap</strong></a> &middot;
+  <a href="#citation"><strong>Citation</strong></a>
+</p>
+
+**Text-to-satellite-image diffusion, packaged.** rsdiff is the reference implementation
+of RSDiff ([Neural Computing and Applications, 2024](https://doi.org/10.1007/s00521-024-10363-3)):
+a T5-conditioned, Imagen-style cascaded diffusion model that turns a caption such as
+"many buildings and green trees are around a playground ." into a 256x256 synthetic
+remote-sensing image. One command downloads the released RSICD-trained checkpoint,
+verifies it, and samples; a second scores the result with the same FID and CLIP-score
+protocol used for the published numbers (FID 65.70, CLIP-score 0.278 on the full
+RSICD test split).
+
+Every image rsdiff produces is synthetic. It is not an observation or a prediction of
+any real place, and each PNG says so in its metadata.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/asebaq/rsdiff/main/docs/figures/sample_montage.png" width="780" alt="Synthetic 256x256 samples generated from RSICD test captions">
+</p>
+
+## Install
+
+```bash
+pip install rsdiff            # sampling + CLIP-score
+pip install "rsdiff[eval]"    # adds torchmetrics for FID
+```
+
+Python 3.10+. Sampling runs on CUDA when available and otherwise on CPU. Apple MPS is
+not supported: imagen-pytorch 2.1.0 and the torchmetrics FID both use float64.
+
+## Use
+
+Generate images from your own captions. The first run downloads the released checkpoint
+(1.9 GB, pinned Hugging Face revision) and verifies its SHA-256:
+
+```bash
+rsdiff sample --prompt "many buildings and green trees are around a playground ." -n 4 --out-dir generated
+```
+
+This writes 256x256 PNGs and a `captions.txt` to `generated/`. `--prompt` can be
+repeated. Each PNG carries `Software`, `Description` (a synthetic-content notice), and
+`Prompt` text chunks.
+
+Or draw captions from RSICD (first caption, `sent1`, shuffled with `--seed`, default 17):
+
+```bash
+rsdiff sample --rsicd data/RSICD_optimal --split test -n 16 --out-dir generated
+```
+
+Useful options: `--cond-scale` (default 5), `--batch-size` (default 2), `--lr-only`
+(stop at the 128x128 base stage), `--cpu`, `--config rsdiff1.5|rsdiff1|path.yaml`, and
+`--checkpoint PATH` (required for non-default configs). An interrupted run resumes:
+batches whose PNGs already exist are skipped.
+
+Score a generated directory against the RSICD test split:
+
+```bash
+rsdiff eval fid generated --rsicd data/RSICD_optimal    # --feature 2048 --size 256 by default
+rsdiff eval clip generated                             # clip_score, clip_score_shuffled, delta
+```
+
+Both print JSON. The same pieces are available from Python:
+
+```python
+from rsdiff.cascade import download_release, generate, load_cascade
+from rsdiff.config import load_preset
+from rsdiff.eval import clip_score
+
+cfg = load_preset("rsdiff1.5")
+trainer = load_cascade(cfg, download_release())
+paths = generate(trainer.sample, ["a river runs through the green farmland ."], "generated")
+print(clip_score("generated"))
+```
+
+`rsdiff.datasets.rsicd.sample_captions` reproduces the CLI's RSICD caption draw, and
+`rsdiff.eval.fid` computes FID.
+
+## Results
+
+Released checkpoint, full RSICD test split (N=1,093), cascade output at 256x256,
+`cond_scale=5`:
+
+| Metric | Value |
+| --- | --- |
+| FID (torchmetrics Inception, feature 2048, both sides at 256) | **65.70** |
+| CLIP-score (OpenAI CLIP ViT-B/32) | **0.278** |
+| CLIP-score, shuffled-caption baseline | 0.232 |
+| Parameters (base UNet 27.2 M + SR UNet 92.7 M) | 119.9 M[^params] |
+
+[^params]: 119.9 M counts the two standalone UNets, as in the paper and model card.
+    Loaded inside the cascade, the SR UNet gains low-resolution conditioning layers
+    (105.0 M), so the cascade holds 132.2 M trainable parameters, plus the frozen T5-base
+    text encoder.
+
+The CLIP-score sits 0.046 above the shuffled-caption baseline: the images follow their
+captions, not just the RSICD domain.
+
+| Curve | Figure |
+| --- | --- |
+| SR FID versus epoch (ep150 to ep1000) | [`docs/figures/sr_fid_curve.png`](docs/figures/sr_fid_curve.png) |
+| CFG `cond_scale` sweep on the selected SR milestone | [`docs/figures/cfg_sweep.png`](docs/figures/cfg_sweep.png) |
+| LR base FID versus epoch | [`docs/figures/lr_fid_curve.png`](docs/figures/lr_fid_curve.png) |
+
+The numbers behind every figure are committed in [`results/`](results/). Methodology and
+discussion: [`docs/REPORT.md`](docs/REPORT.md). Model card:
+[`docs/model_card.md`](docs/model_card.md).
+
+## How it works
+
+1. A frozen **T5-base** encoder turns the caption into token embeddings.
+2. A **128x128 base UNet** denoises from noise over 1,000 DDPM steps, cross-attending to
+   the text.
+3. A **256x256 super-resolution UNet** denoises again, conditioned on the text and the
+   upsampled base image.
+
+Both stages use classifier-free guidance (trained with 10% caption dropout) with a shared
+`cond_scale`; 5 is the value selected by the CFG sweep and used for every headline
+number. Sampling uses the EMA weights of the merged epoch-650 checkpoint. The presets
+ship inside the package: [`rsdiff1.5`](src/rsdiff/configs/rsdiff1.5.yaml) (released) and
+[`rsdiff1`](src/rsdiff/configs/rsdiff1.yaml) (the 723 M paper configuration; weights not
+released).
+
+## Limitations
+
+- **Synthetic only.** Outputs are plausible-looking imagery, not observed or predicted
+  geography. Do not use them as evidence about a real location.
+- **RSICD domain.** The model was trained on the 30 RSICD scene types and their short,
+  lowercase captions. Prompts unlike those captions have not been evaluated.
+- **256 px.** The cascade stops at 256x256.
+- **No Apple MPS.** float64 operations in imagen-pytorch 2.1.0 and torchmetrics FID are
+  not supported on MPS.
+- **CPU sampling is slow.** 2,000 denoising steps per image took about an hour on an
+  Apple-silicon CPU; use a CUDA GPU for more than a handful of images.
+- **Weights not commercially cleared.** RSICD's commercial terms are unresolved; see
+  [`docs/LICENSE_AUDIT.md`](docs/LICENSE_AUDIT.md).
+
+## Training
+
+Training still runs through the frozen reference implementation in [`ddpm/`](ddpm/):
+
+```bash
+bash ddpm/scripts/run_training_local.sh   # stage 1: 128x128 base UNet
+bash ddpm/scripts/run_sr.sh               # stage 2: 256x256 SR UNet on the frozen base
+```
+
+[`docs/reproducibility.md`](docs/reproducibility.md) is the complete runbook: environment,
+dataset preparation, training, milestone sweeps, sampling the 1,093-image bundle, and
+scoring.
+
+## Roadmap
+
+1. **Reproduce with the package.** Regenerate the 1,093-image bundle with `rsdiff sample`
+   and match the published FID and CLIP-score; then delete `ddpm/`.
+2. **Commercial relevance.** Test whether synthetic augmentation improves a downstream
+   model on an untouched real-data test set.
+
+Details and acceptance criteria: [`docs/PLAN.md`](docs/PLAN.md).
+
+## Citation
+
+```bibtex
+@article{sebaq2024rsdiff,
+  title   = {RSDiff: remote sensing image generation from text using diffusion model},
+  author  = {Sebaq, Ahmad and ElHelw, Mohamed},
+  journal = {Neural Computing and Applications},
+  volume  = {36},
+  number  = {36},
+  pages   = {23103--23111},
+  year    = {2024},
+  doi     = {10.1007/s00521-024-10363-3}
+}
+```
+
+## License
+
+Code: Apache-2.0, see [`LICENSE`](LICENSE) and [`NOTICE`](NOTICE). The released weights
+were trained on RSICD, whose commercial terms are unresolved; dataset, dependency, and
+derived-weight rights are tracked in [`docs/LICENSE_AUDIT.md`](docs/LICENSE_AUDIT.md).
+Built on [`lucidrains/imagen-pytorch`](https://github.com/lucidrains/imagen-pytorch);
+developed at the Center for Informatics Science, Nile University.