Skip to content

README.md

Latest commit

 

History

History
206 lines (156 loc) · 7.27 KB

README.md

File metadata and controls

206 lines (156 loc) · 7.27 KB
Raw

StyleGAN.pytorch

A historical, unofficial PyTorch implementation of the original StyleGAN.

This repository implements the StyleGAN architecture described in A Style-Based Generator Architecture for Generative Adversarial Networks. It was created before NVIDIA published its later official PyTorch implementations and is kept useful for historical reproducibility, code reading, and experiments that depend on this codebase.

For new projects, start with NVIDIA's official StyleGAN2-ADA PyTorch implementation instead.


ChineseGirl Dataset

Project status

This is legacy research software under conservative maintenance. The repository does not currently claim a supported Python/PyTorch/CUDA compatibility matrix, CPU-only support, numerical equivalence with NVIDIA checkpoints, or reproducible training on modern environments. Those claims require verification before they are added to the documentation.

The configuration files contain machine-specific dataset and output paths. Edit those paths before starting a training run. Pretrained weights and datasets are not included in this repository.

Implemented features

  • Progressive growing and fade-in training
  • Exponential moving average of generator weights
  • Equalized learning rate
  • PixelNorm and minibatch standard deviation layers
  • Style mixing regularization
  • Truncation trick
  • Conditional GAN mode
  • Gradient clipping and several legacy GAN loss options
  • TensorFlow-to-PyTorch checkpoint conversion through convert.py (legacy path; conversion compatibility is not currently verified)

The following are not implemented or are not currently validated:

  • Multi-GPU/distributed training
  • FP16 or mixed-precision support
  • A modern packaging or installation workflow
  • A maintained pretrained-weight release

Installation

The intended legacy dependency setup is:

python -m pip install -r requirements.txt

requirements.txt intentionally reflects the historical project and does not pin versions. The repository's modern compatibility baseline is still being established, so the command above should not be interpreted as a guarantee that the project works with every current Python or PyTorch release.

The optional convert.py workflow additionally requires a TensorFlow environment compatible with the original NVIDIA checkpoint tooling. It is separate from the default training and generation dependencies.

Training

  1. Choose a configuration under configs/.
  2. Update output_dir, dataset.img_dir, dataset.resolution, and the device settings for your machine.
  3. Start training:
python train.py --config configs/sample.yaml

The sample configurations target the historical progressive-training workflow and generally assume CUDA. Training is expected to require a dataset arranged as either a flat directory or a directory of subdirectories, according to the configuration's dataset.folder value.

To resume from checkpoints produced by this repository, provide actual checkpoint paths (the examples below use placeholders):

python train.py \
  --config configs/sample.yaml \
  --start_depth 5 \
  --generator_file path/to/generator.pth \
  --gen_shadow_file path/to/generator_shadow.pth \
  --discriminator_file path/to/discriminator.pth \
  --gen_optim_file path/to/generator_optimizer.pth \
  --dis_optim_file path/to/discriminator_optimizer.pth

Generation

All generation scripts expect a generator checkpoint produced by this repository or by the conversion workflow below. Use a configuration matching the checkpoint's resolution and model settings.

Generate individual samples:

python generate_samples.py \
  --config configs/sample_ffhq_128.yaml \
  --generator_file path/to/generator.pth \
  --num_samples 20 \
  --output_dir output/samples

Generate a grid:

python generate_grid.py \
  --config configs/sample_ffhq_128.yaml \
  --generator_file path/to/generator.pth \
  --output_dir output/grid

Style mixing and truncation figures are generated with:

python generate_mixing_figure.py \
  --config configs/sample_race_256.yaml \
  --generator_file path/to/generator.pth

python generate_truncation_figure.py \
  --config configs/sample_cari2_128_truncation.yaml \
  --generator_file path/to/generator.pth

Converting an official TensorFlow checkpoint

convert.py contains the historical TensorFlow-to-PyTorch parameter translation:

python convert.py \
  --config configs/sample_ffhq_1024.yaml \
  --input_file path/to/karras2019stylegan-ffhq-1024x1024.pkl \
  --output_file ffhq_1024_gen.pth

This path uses legacy TensorFlow utilities and Python pickle checkpoints. Only use checkpoint files from a trusted source, and treat conversion results as requiring validation until compatibility tests are available.

Example outputs

The images below are historical examples checked into the repository; they are not a guarantee that the same outputs can be reproduced in a current environment.


FFHQ Dataset (128x128)


FFHQ Dataset (1024x1024)


WebCaricature Dataset (128x128)

Repository references

Maintenance queue

The current open Issue inventory and verification plan are tracked in docs/issue-triage.md. Reports are classified by priority, but remain unverified until a reproduction or supporting evidence is recorded.

The current weight-conversion findings are recorded in docs/weight-conversion-research.md, and the staged maintenance and research roadmap is in docs/iteration-roadmap.md.

License and provenance

The repository includes LICENSE.txt and LICENSE_ORIGINAL.txt. The source contains code and adaptations attributed in the repository to NVIDIA StyleGAN and other upstream projects. A file-by-file provenance and licensing review is still pending; do not infer from this README that the whole repository is OSI-licensed or that all files have the same copyright holder. Preserve the relevant upstream notices when redistributing or modifying the code.

See NOTICE.md for a concise third-party notice and docs/license-provenance.md for the current component-level audit and open questions.

Contributing

Small, reviewable maintenance fixes are welcome. Please include reproduction steps and validation results for compatibility or correctness changes. Issues and pull requests should distinguish verified behavior from historical assumptions.