danforbes commited on
Commit
4cd1e8c
1 Parent(s): df58fe1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +20 -15
README.md CHANGED
@@ -1,27 +1,32 @@
1
  ---
2
  title: README
3
- emoji: 😻
4
- colorFrom: blue
5
- colorTo: red
6
- sdk: static
7
  pinned: false
8
  ---
9
 
10
- # Rustformers - Large Language Models in Rust
11
 
12
- Rustformers is a developer-centric initiative aiming to bring the robustness and efficiency of Rust to the world of large language models. At the core of this initiative is llm (Large Language Models), an ecosystem of Rust libraries specifically designed for handling and interacting with large language models.
 
 
 
13
 
14
- ## About `llm`
15
 
16
- `llm` is a set of Rust libraries that provide an interface for working with large language models. It is built on top of the fast, efficient [GGML](./crates/ggml) library for machine learning. `llm` includes support for various models such as BLOOM, GPT-2, GPT-J, GPT-NeoX, LLaMA, and MPT. The `llm` crate serves as a primary entry point for developers and also provides a CLI (Command Line Interface) for end users to interact with these models.
17
 
18
- You can include `llm` in your Rust projects by listing it as a dependency in your `Cargo.toml` file. The package requires Rust v1.65.0 or above and a modern C toolchain for building. Detailed instructions on how to use `llm` in a Rust project and via the `llm` CLI are provided in the documentation.
19
 
20
- ## Contact Us
 
 
 
 
 
21
 
22
- For any queries or support related to `llm`, feel free to raise an [issue](https://github.com/rustformers/llm/issues/new) on our GitHub repository or start a [discussion](https://github.com/rustformers/llm/discussions/new). We are also available on [Discord](https://discord.gg/YB9WaXYAWU), where you can chat with us directly. We encourage contributions and look forward to your involvement in enhancing `llm`!
23
-
24
- ## Further Reading
25
-
26
- For more information, please refer to the [documentation](https://docs.rs/llm). The documentation provides an in-depth guide to using `llm` in your Rust projects, getting models, using the `llm` CLI, and answers to frequently asked questions.
27
 
 
 
 
1
  ---
2
  title: README
3
+ emoji: 🦀
4
+ colorFrom: red
5
+ colorTo: yellow
 
6
  pinned: false
7
  ---
8
 
9
+ # rustformers - Large Language Models in Rust
10
 
11
+ rustformers is a group that wants to make it easy for Rust developers to access the power of large language models (LLMs).
12
+ As of June 2023, the focus is on keeping pace with the fast-moving [GGML](https://github.com/ggerganov/ggml) ecosystem -
13
+ a C library that uses quantization to make it possible to run LLMs on the CPU.
14
+ In the future, there will be support for other backends that allow running LLMs on GPUs, in Wasm environments, and more.
15
 
16
+ This 🤗 space will host models vetted by the rustformers team.
17
 
18
+ If you're a Rust developer and are looking to build with LLMs, keep reading to learn about `llm` - a Rust crate that is the entry point to the rustformers ecosystem.
19
 
20
+ ## `llm`
21
 
22
+ The `llm` crate exposes an interface for working with LLMs and provides implementations for many popular model architectures,
23
+ including BLOOM, GPT-2, GPT-J, GPT-NeoX, LLaMA, and MPT.
24
+ The `llm` project includes a simple CLI for [interacting with LLMs](https://github.com/rustformers/llm#usage),
25
+ as well as [examples](https://github.com/rustformers/llm/tree/main/crates/llm/examples) of how to use `llm` in a Rust project.
26
+ To learn more about `llm`, visit its [GitHub repository](https://github.com/rustformers/llm)
27
+ or check out the [official documentation](https://docs.rs/llm) for released versions.
28
 
29
+ ## Get in Touch!
 
 
 
 
30
 
31
+ We're building a community of enthusiastic developers and would love for you to join! If you're looking to chat, check out our [Discord](https://discord.gg/YB9WaXYAWU).
32
+ We also actively monitor GitHub [Issues](https://github.com/rustformers/llm/issues/new) and [Discussions](https://github.com/rustformers/llm/discussions/new).