Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos and some grammar in README #20

Merged
merged 2 commits into from
Apr 28, 2023
Merged

Fix typos and some grammar in README #20

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d417a0
Fix typos and some grammar in README
saharNooby Apr 27, 2023
d8f3646
docs: Removed outdated text
BrutalCoding Apr 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@

## Getting Started

Unlike the majority of the frontends for the AI models, this project aims to be easier than even those with 1-click installers to launch a web app.
Unlike the majority of frontends for AI models, this project aims to be easier than even those with 1-click installers to launch a web app.

### Website

Visit [shady.ai](https://shady.ai) (experimental!). This web-app gets freshly build and deployed every night at 00:00 UTC, as seen on the [deployments page](https://github.com/BrutalCoding/shady.ai/deployments?environment=github-pages#activity-log).
Visit [shady.ai](https://shady.ai) (experimental!). This web-app gets freshly built and deployed every night at 00:00 UTC, as seen on the [deployments page](https://github.com/BrutalCoding/shady.ai/deployments?environment=github-pages#activity-log).

### Other platforms

Expand All @@ -30,7 +30,7 @@ No builds are available yet.

## Benchmark

My dad, the retired butcher in his mid-70's, is going to be the benchmark.
My dad, the retired butcher in his mid-70s, is going to be the benchmark.

If dad the retired butcher can install ShadyAI and interact with AI, it's a pass. Otherwise there's room for improvements to be made.

Expand All @@ -42,7 +42,7 @@ That's him 👇

## Goal

The goal is to have a "normal" app for all platforms, including Windows, Mac, Linux, iOS, Android and web. Should be as simple as downloading the app and running it. No need to install Python, download models, install dependencies, etc.
The goal is to have a "normal" app for all platforms, including Windows, Mac, Linux, iOS, Android and Web. Should be as simple as downloading the app and running it. No need to install Python, download models, install dependencies, etc.

The web version will be powered by [Serverpod](https://github.com/serverpod/serverpod) as the backend. A experimental web version is available on [shady.ai](https://shady.ai). No guarantees on the ease of use, but I'll try my best. It's going to be a bumpier ride than the other frontends, but I'm up for the challenge.

Expand Down Expand Up @@ -76,13 +76,11 @@ July 2023 - Real Shady
- [ ] Prototyping with voice synthesis and music generation.
- [ ] Trying out WASM for Flutter web (experimental)

*Stretch goal. 7B is the size of the model, which might be too big for Android for a good user experience. Quantized models on smaller models tend to be completely broken. There's lots of developments in the field of quantization, which I'm keeping an eye on.

## Tech Stack

- [Flutter](https://flutter.dev/) - Frontend (in Dart)
- [Serverpod](https://serverpod.dev/) - Backend (in Dart)
- [rwkv.cpp](https://github.com/saharNooby/rwkv.cpp) - Allows me to run one of BlinkDL's models on the CPU, fast intference.
- [rwkv.cpp](https://github.com/saharNooby/rwkv.cpp) - Allows me to run one of BlinkDL's models on the CPU, fast inference.
- [Design System](https://m3.material.io/) - Design system made by Google for their own apps. I will use their Figma template and their theme builder generator (official Flutter support)
- And many more...

Expand Down