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.

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

Update README.MD #848

Merged
merged 2 commits into from
Oct 16, 2024
Merged
Changes from all commits
Commits
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: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Please submit requests for new models [here](https://github.com/EricLBuehler/mis

- Other models: [see a support matrix](#support-matrix) and [how to run them](#run-with-the-cli)

Mistal.rs supports several model categories:
Mistral.rs supports several model categories:
- Text to Text
- Text+Image to Text: Vision (see [the docs](docs/VISION_MODELS.md))
- Text to Image: Image Generation (see [the docs](docs/IMAGEGEN_MODELS.md))
Expand Down Expand Up @@ -202,7 +202,7 @@ Enabling features is done by passing `--features ...` to the build system. When

- Install the [Python package here](mistralrs-pyo3/README.md).

1) Install required packages
1) Install required packages:
- `OpenSSL` (*Example on Ubuntu:* `sudo apt install libssl-dev`)
- <b>*Linux only:*</b> `pkg-config` (*Example on Ubuntu:* `sudo apt install pkg-config`)

Expand All @@ -220,13 +220,13 @@ Enabling features is done by passing `--features ...` to the build system. When
huggingface-cli login
```

4) Download the code
4) Download the code:
```bash
git clone https://github.com/EricLBuehler/mistral.rs.git
cd mistral.rs
```

5) Build or install
5) Build or install:
- Base build command
```bash
cargo build --release
Expand Down Expand Up @@ -257,14 +257,14 @@ Enabling features is done by passing `--features ...` to the build system. When
```bash
cargo install --path mistralrs-server --features cuda
```
6) The build process will output a binary `misralrs-server` at `./target/release/mistralrs-server` which may be copied into the working directory with the following command:
6) The build process will output a binary `mistralrs-server` at `./target/release/mistralrs-server` which may be copied into the working directory with the following command:

*Example on Ubuntu:*
```
cp ./target/release/mistralrs-server ./mistralrs-server
```

7) Use our APIs and integrations
7) Use our APIs and integrations:

[APIs and integrations list](#apis-and-integrations)

Expand Down
Loading