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: 6 days ago
JSON representation
Typst symbol classifier
- Host: GitHub
- URL: https://github.com/QuarticCat/detypify
- Owner: QuarticCat
- License: mit
- Created: 2024-03-20T12:01:23.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-14T01:03:15.000Z (7 months ago)
- Last Synced: 2024-04-14T04:23:38.444Z (7 months ago)
- Topics: image-classification, typst
- Language: Svelte
- Homepage: https://detypify.quarticcat.com/
- Size: 2.22 MB
- Stars: 66
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-typst - Detypify - Typst symbol classifier (Integrations & Tools / Online Tools)
README
## Features
- **PWA**: installable and works offline
- **Tiny model**: 1.3 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).
## Associated Repos
- [detypify-data](https://github.com/QuarticCat/detypify-data): Detypify's own dataset (your contributions on the website finally go here)
- [detypify-external](https://github.com/QuarticCat/detypify-external): Necessary external data to bootstrap Detypify
## Use As A Library
Use the [detypify-service](https://www.npmjs.com/package/detypify-service) NPM package.
## Self Deployment
Download files from [gh-pages](https://github.com/QuarticCat/detypify/tree/gh-pages) branch and host them using any HTTP server.
## 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` from [NPM](https://www.npmjs.com/package/detypify-service?activeTab=code) to project root.
### 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 run --cwd=service copy # copy train-out folder
$ 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`.
1. Move them to [web/public/icons](web/public/icons).
## License
MIT
