Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/QuarticCat/detypify

Typst symbol classifier
https://github.com/QuarticCat/detypify

image-classification typst

Last synced: 2 months ago
JSON representation

Typst symbol classifier

Lists

README

        


logo

Detypify



Can't remember Typst symbols?
Draw it!


## Features

- **PWA**: installable and works offline
- **Tiny model**: 1.1 MiB (ONNX), fast to load and run
- **Decent symbol set**: support 400+ symbols

## News

- 2024-04-06: This project has been integrated into Tinymist. [🔗](https://github.com/Myriad-Dreamin/tinymist/releases/tag/v0.11.3)

## Associated Repos

- [detypify-data](https://github.com/QuarticCat/detypify-data): Detypify's own dataset (your contribution on the website finally goes here)
- [detypify-external](https://github.com/QuarticCat/detypify-external): Necessary external data to bootstrap Detypify

## Development

If you want to build `migrate` or `train`, you need to pull submodules. ([Git LFS](https://git-lfs.com/) is required)

```console
$ git submodule update --init --recursive
```

If you just want to build `web`, you can download `train-out.zip` from releases and extract it to project folder.

### Migrating

```console
$ rye sync # install venv and denpendencies
$ rye run migrate # migrate
$ rye run migrate-font # strip font (optional)
```

### Training

```console
$ rye sync # install venv and denpendencies
$ rye run train # train
```

### Web Page

```console
$ bun install # install dependencies
$ bun run dev # start dev server
$ bun run build # build for production
```

### Logo & Favicons (Optional)

1. Install *NewComputerModernMath* font ([guide](https://wiki.archlinux.org/title/TeX_Live#Making_fonts_available_to_Fontconfig))

1. Convert `manuscript.svg`

```console
$ cd assets
$ inkscape manuscript.svg --export-text-to-path --export-filename=logo.svg
$ bunx svgo --multipass logo.svg
```

1. Generate favicons by [Favicon InBrowser.App](https://favicon.inbrowser.app/tools/favicon-generator) using `logo.svg`

## License

MIT