Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
duskvirkus authored Jan 17, 2022
1 parent 508690c commit f7350c9
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,37 @@
# Compose

⚠️ This project is a work in progress and is likely to be buggy and maybe abandon if it doesn't make sense.
⚠️ This project is still in development. Please report bug but don't expect everything to work very smoothly.

A module with scripts and jupyter/colab notebooks for creating 2d vector graphics using machine learning.
A python module to streamline working with 2D and 3D vector graphics in machine learning projects.

## Notebooks

Image to SVG Notebook
Much of the philosophy of this module is based on [Processing](https://processing.org/) and [p5.js](https://p5js.org/). In other words it favors more accessible syntax over complete efficiency.

`coming soon`
## Notebooks

Image to Plotter SVG
Single Image Notebook: [./notebooks/compose_test_01_py.ipynb](./notebooks/compose_test_01_py.ipynb)

`coming soon`
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/duskvirkus/compose/blob/main/notebooks/compose_test_01_py.ipynb)

Create Animation
Video Notebook (very hacky): [./notebooks/compose_test_04_py.ipynb](./notebooks/compose_test_04_py.ipynb)

`coming soon`
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/duskvirkus/compose/blob/main/notebooks/compose_test_04_py.ipynb)

## Installing Locally

For a more streamlined process use jupyter lab and vanilla jupyter notebooks.

### Python Config
### Platform

Recommended python version is 3.7. Ubuntu based Linux is currently the only supported platform. If you run into issues on other platforms feel free to file an issue but it will be low priority.

*If you use Anaconda*
### Anaconda Setup

```bash
conda create -n compose python=3.7
conda activate compose
conda install -c conda-forge jupyterlab
conda install -c anaconda ipykernel
python -m ipykernel install --user --name=compose
```

### Dependancies

```bash
Expand All @@ -48,6 +46,10 @@ cd ..
python setup.py install
```

## Documentation

Currently documentation could use some work and can only be built locally. See CONTRIBUTING.md for some instructions.

## Thanks

This project would not be possible without the work of the creators of diffvg Tzu-Mao Li, Michal Lukáč, Michaël Gharbi, and Jonathan Ragan-Kelley.
Expand Down

0 comments on commit f7350c9

Please sign in to comment.