Pytorch-SVGRender

Pytorch-SVGRender: The go-to library for differentiable rendering methods for SVG generation.

Updates • Table of Contents • Installation • Quickstart • FAQ • TODO • Contribution • Acknowledgment • Citation • Licence

🔥 Recent Updates

• [12/2023] 🔥 We open-sourced Pytorch-SVGRender V1.0.

💡 Table of Contents

^{▴ Back to top}

1. Image Vectorization

• DiffVG: Differentiable Vector Graphics Rasterization for Editing and Learning (SIGGRAPH 2020)

  [Project] [Paper] [Code]

  DiffVG is a differentiable rasterizer for 2D vector graphics. This repository is heavily based on DiffVG.

• LIVE: Towards Layer-wise Image Vectorization (CVPR 2022)

  [Project] [Paper] [Code]

• CLIPasso: Semantically-Aware Object Sketching (SIGGRAPH 2022)

  [Project] [Paper] [Code]

• CLIPascene: Scene Sketching with Different Types and Levels of Abstraction (ICCV 2023)

  [Project] [Paper] [Code]

2. Text-to-SVG Synthesis

• CLIPDraw: Exploring Text-to-Drawing Synthesis through Language-Image Encoders (NIPS 2022)

  [Paper] [Code]

• StyleCLIPDraw: Coupling Content and Style in Text-to-Drawing Synthesis

  [Live] [Paper] [Code]

• CLIPFont: Texture Guided Vector WordArt Generation (BMVC 2022)

  [Paper] [Code]

• VectorFusion: Text-to-SVG by Abstracting Pixel-Based Diffusion Models (CVPR 2023)

  [Project] [Paper]

• DiffSketcher: Text Guided Vector Sketch Synthesis through Latent Diffusion Models (NIPS 2023)

  [Project] [Live] [Paper] [Code]

• Word-As-Image for Semantic Typography (SIGGRAPH 2023)

  [Project] [Paper] [Code]

• SVGDreamer: Text Guided SVG Generation with Diffusion Model (CVPR 2024)

  [Project] [Paper] [Code] [Blog]

⚙️ Installation

🛠️ Step 1: Set Up the Environment

To quickly get started with PyTorch-SVGRender, follow the steps below.
These instructions will help you run quick inference locally.

🚀 Option 1: Standard Installation

Run the following command in the top-level directory:

chmod +x script/install.sh
bash script/install.sh

🐳 Option 2: Using Docker

chmod +x script/run_docker.sh
sudo bash script/run_docker.sh

👩‍🎨🎨 Quickstart

^{▴ Back to top}

For more information, read the docs.

1. Basic Usage

DiffVG vectorizes any raster images:

python svg_render.py x=diffvg target='./data/fallingwater.png'
# change 'num_paths' and 'num_iter' for better results
python svg_render.py x=diffvg target='./data/fallingwater.png' x.num_paths=512 x.num_iter=2000

LIVE vectorizes the raster emojis images (in original PNG format):

python svg_render.py x=live target='./data/simile.png'
# change 'num_paths' and 'schedule_each' for better results
python svg_render.py x=live target='./data/simile.png' x.num_paths=5 x.schedule_each=1

CLIPasso synthesizes vectorized sketches from images:

note: first download the U2Net model sh script/download_u2net.sh.

python svg_render.py x=clipasso target='./data/horse.png'

CLIPascene synthesizes vectorized sketches from images:

note: first download the U2Net model bash script/download_u2net.sh.

python svg_render.py x=clipascene target='./data/ballerina.png'

CLIPDraw synthesizes SVGs based on text prompts:

python svg_render.py x=clipdraw "prompt='a photo of a cat'"

StyleCLIPDraw synthesizes SVG based on a text prompt and a reference image:

python svg_render.py x=styleclipdraw "prompt='a photo of a cat'" target='./data/starry.png'

CLIPFont styles vector fonts according to text prompts:

python svg_render.py x=clipfont "prompt='Starry Night by Vincent van gogh'" target='./data/alphabet1.svg'

---

Note: Since the following methods rely on Stable Diffusion, add diffuser.download=True to the command the first time you run the script.

SVGDreamer generates diverse SVG styles based on text prompts. It supports six vector primitives: Iconography, Sketch, Pixel Art, Low-Poly, Painting, and Ink & Wash.

# 🖼️ Primitive: Iconography
## 1. German shepherd
python svg_render.py x=svgdreamer state.mprec='fp16' "prompt='A colorful German shepherd in vector art. tending on artstation.'" save_step=50 x.guidance.n_particle=6 x.guidance.vsd_n_particle=4 x.guidance.phi_n_particle=2 result_path='svgdreamer/GermanShepherd'
## 2. sydney opera house
python svg_render.py x=svgdreamer state.mprec='fp16' "prompt='Sydney opera house. oil painting. by Van Gogh'" save_step=50 x.guidance.n_particle=6 x.guidance.vsd_n_particle=4 x.guidance.phi_n_particle=2 x.num_paths=512 result_path='svgdreamer/SydneyOperaHouse'

# 🔺 Primitive: Low-Poly
python svg_render.py x=svgdreamer state.mprec='fp16' "prompt='A picture of a bald eagle. low-ploy. polygon'" x.style='low-poly' save_step=50 x.guidance.n_particle=6 x.guidance.vsd_n_particle=4 x.guidance.phi_n_particle=2 x.grid=30 x.guidance.num_iter=1000 result_path='svgdreamer/BaldEagle'

# 🎨 Primitive: Pixel Art
python svg_render.py x=svgdreamer state.mprec='fp16' "prompt='Darth vader with lightsaber. ultrarealistic. pixelart. trending on artstation.'" x.style='pixelart' save_step=50 x.guidance.n_particle=6 x.guidance.vsd_n_particle=4 x.guidance.phi_n_particle=2 x.guidance.num_iter=1000 result_path='svgdreamer/DarthVader'

# 🖌️ Primitive: Painting
python svg_render.py x=svgdreamer state.mprec='fp16' "prompt='self portrait of Van Gogh. oil painting. cmyk portrait. multi colored. defiant and beautiful. cmyk. expressive eyes.'" x.style='painting' save_step=50 x.guidance.n_particle=6 x.guidance.vsd_n_particle=4 x.guidance.phi_n_particle=2 x.guidance.t_schedule='randint' x.num_paths=1500 result_path='svgdreamer/VanGogh_portrait'

# ✏️ Primitive: Sketch
python svg_render.py x=svgdreamer state.mprec='fp16' "prompt='A free-hand drawing of A speeding Lamborghini. black and white drawing.'" x.style='sketch' save_step=50 x.guidance.n_particle=6 x.guidance.vsd_n_particle=4 x.guidance.phi_n_particle=2 x.guidance.t_schedule='randint' x.num_paths=128 result_path='svgdreamer/Lamborghini'

# 🏯 Primitive: Ink & Wash
python svg_render.py x=svgdreamer state.mprec='fp16' "prompt='Big Wild Goose Pagoda. ink style. Minimalist abstract art grayscale watercolor.'" x.style='ink' save_step=50 x.guidance.n_particle=6 x.guidance.vsd_n_particle=4 x.guidance.phi_n_particle=2 x.guidance.t_schedule='randint' x.num_paths=128 x.width=6 result_path='svgdreamer/BigWildGoosePagoda'

VectorFusion synthesizes SVGs in various styles based on text prompts:

# 🖼️ Primitive: Iconography
python svg_render.py x=vectorfusion x.style='iconography' "prompt='a panda rowing a boat in a pond. minimal flat 2d vector icon. lineal color. trending on artstation.'"

# 🎨 Primitive: Pixel Art
python svg_render.py x=vectorfusion x.style='pixelart' "prompt='a panda rowing a boat in a pond. pixel art. trending on artstation.'"

# ✏️ Primitive: Sketch
python svg_render.py x=vectorfusion x.style='sketch' "prompt='a panda rowing a boat in a pond. minimal 2d line drawing. trending on artstation.'"

Following SVGDreamer, we've added three additional styles (Paining, Ink and Wash and low-ploy) to VectorFusion.

DiffSketcher synthesizes vector sketches based on text prompts:

# DiffSketcher
python svg_render.py x=diffsketcher "prompt='a photo of Sydney opera house'" x.token_ind=5 seed=8019

# DiffSketcher, variable stroke width
python svg_render.py x=diffsketcher "prompt='a photo of Sydney opera house'" x.token_ind=5 x.optim_width=True seed=8019

# DiffSketcher RGBA version
python svg_render.py x=diffsketcher "prompt='a photo of Sydney opera house'" x.token_ind=5 x.optim_width=True x.optim_rgba=True x.optim_opacity=False seed=8019

# DiffSketcher + style transfer
python svg_render.py x=stylediffsketcher "prompt='The French Revolution. highly detailed. 8k. ornate. intricate. cinematic. dehazed. atmospheric. oil painting. by Van Gogh'" x.token_ind=4 x.num_paths=2000 target='./data/starry.png' seed=876809

Word-As-Image follow a text prompt to style a letter in a word:

# Inject the meaning of the word bunny into the 'Y' in the word 'BUNNY'
python svg_render.py x=wordasimage x.word='BUNNY' prompt='BUNNY' x.optim_letter='Y'
# Change font: 'LuckiestGuy-Regular', default: 'KaushanScript-Regular'
python svg_render.py x=wordasimage x.word='DRAGONFLY' prompt='Dragonfly' x.optim_letter='Y' x.font='LuckiestGuy-Regular'

2. SDS Loss-based Approach

This approach leverages a pretrained text-to-image diffusion model as a powerful image prior to supervise the training of PyDiffVG, enabling SVG rendering that aligns with textual descriptions. This capability is fundamentally driven by Score Distillation Sampling (SDS), which serves as the key mechanism for bridging raster images from diffusion models to the SVG domain. This allows for the optimization of SVG parameters without requiring explicit image supervision.

Notable methods based on this approach include VectorFusion, DiffSketcher, and SVGDreamer.

We focus solely on evaluating the performance of SDS, meaning no additional loss functions are applied:

# Standard SDS loss
python svg_render.py x=vectorfusion "prompt='a panda rowing a boat in a pond. minimal flat 2d vector icon. lineal color. trending on artstation.'"

# Input Augmentation SDS loss (LSDS loss)
python svg_render.py x=vectorfusion x.style='sketch' "prompt='an elephant. minimal 2d line drawing. trending on artstation.'" x.skip_live=True

# Input Augmentation SDS loss (ASDS loss)
python svg_render.py x=diffsketcher "prompt='an elephant. minimal 2d line drawing. trending on artstation.'" x.token_ind=2 x.sds.grad_scale=1 x.sds.num_aug=4 x.clip.vis_loss=0 x.perceptual.coeff=0 x.opacity_delta=0.3 

# Vectorized Particle-based Score Distillation (VPSD loss)
python svg_render.py x=svgdreamer "prompt='a panda rowing a boat in a pond. minimal flat 2d vector icon. lineal color. trending on artstation.'" save_step=60 x.guidance.n_particle=6 x.guidance.vsd_n_particle=6 x.guidance.phi_n_particle=6 state.mprec='fp16'  

❓ FAQ

^{▴ Back to top}

• Q: Where can I get more scripts and visualizations?

• A: Check the pytorch-svgrender.readthedocs.io.

• Q: An error says HuggingFace cannot find the model in the disk cache.

• A: Add diffuser.download=True to the command for downloading model checkpoints the first time you run the script.

• Q: It says xFormers is not built with CUDA support or xFormers cannot load C++/CUDA extensions.

• A: You need to install xFormers again using the command pip install --pre -U xformers instead of the conda one.

🗒 TODO

^{▴ Back to top}

• SVG Layout Pipeline: Given words and layout attrs, returning layout in SVG format.
• integrated SVGDreamer & SVGDreamer supports fp16 optimization.

🤝 Contribution

• We welcome all contributions! 🚀 If you’ve found a bug or developed a feature that could benefit others, feel free to submit a pull request. Your contributions are invaluable in improving PyTorch-SVGRender community and making it even better!

  For more details, please check our Contribution Guidelines.

  Tip: Before committing your changes, make sure to run test/test_svgrender.py to verify your code. ✅

💘 Acknowledgement

^{▴ Back to top}

The project is built based on the following repository:

BachiLi/diffvg, huggingface/diffusers, threestudio-project/threestudio, yael-vinker/CLIPasso, ximinng/DiffSketcher, THUDM/ImageReward, advimman/lama

We gratefully thank the authors for their wonderful works.

📚 Citation

^{▴ Back to top}

If you use this code for your research, please cite the following work:

@InProceedings{xing2024svgdreamer,
    author    = {Xing, Ximing and Zhou, Haitao and Wang, Chuang and Zhang, Jing and Xu, Dong and Yu, Qian},
    title     = {SVGDreamer: Text Guided SVG Generation with Diffusion Model},
    booktitle = {Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition (CVPR)},
    month     = {June},
    year      = {2024},
    pages     = {4546-4555}
}
@inproceedings{xing2023diffsketcher,
    title={DiffSketcher: Text Guided Vector Sketch Synthesis through Latent Diffusion Models},
    author={XiMing Xing and Chuang Wang and Haitao Zhou and Jing Zhang and Qian Yu and Dong Xu},
    booktitle={Thirty-seventh Conference on Neural Information Processing Systems (NeurIPS)},
    year={2023},
    url={https://openreview.net/forum?id=CY1xatvEQj}
}

Licence

^{▴ Back to top}

This work is licensed under a Mozilla Public License Version 2.0.