Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@Kleczyk
Kleczyk committed Apr 4, 2024
1 parent 70083c7 commit 9567025
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
10 changes: 3 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,16 +63,14 @@
docker compose --profile prod up
```



### Dowload embeding and llm (must have for servis llm and sercis embedning-api to work )

### Embedding api

What you need:
- git lfs https://git-lfs.com/
- ssh key. More info: https://huggingface.co/docs/hub/security-git-ssh or https://huggingface.co/blog/password-git-deprecation
- NVIDIA Docker Toolkit https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html
- git lfs [link](https://git-lfs.com/)
- ssh key. More info: [link](https://huggingface.co/docs/hub/security-git-ssh ) or [link](https://huggingface.co/blog/password-git-deprecation)
- NVIDIA Docker Toolkit [link]([URL](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html))
- GPU From nvidia

```sh
Expand All @@ -97,5 +95,3 @@ or
```sh
wget -P ./llm/models/llama-2-7b.Q3_K_L.gguf https://huggingface.co/TheBloke/Llama-2-7B-GGUF/resolve/main/llama-2-7b.Q3_K_L.gguf
```


11 changes: 8 additions & 3 deletions embedingModels/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## How run servis

Check failure on line 3 in embedingModels/README.md

View workflow job for this annotation

GitHub Actions / build

Trailing spaces 

embedingModels/README.md:3:18 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md009.md

### GPU option

1. Instal git lfs
2. NVIDIA Docker Toolkit https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html

Check failure on line 8 in embedingModels/README.md

View workflow job for this annotation

GitHub Actions / build

Bare URL used 

embedingModels/README.md:8:27 MD034/no-bare-urls Bare URL used [Context: "https://docs.nvidia.com/datace..."] https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md034.md
3. Add shh key to hugingface account https://huggingface.co/docs/hub/security-git-ssh or https://huggingface.co/blog/password-git-deprecation

Check failure on line 9 in embedingModels/README.md

View workflow job for this annotation

GitHub Actions / build

Line length 

embedingModels/README.md:9:81 MD013/line-length Line length [Expected: 80; Actual: 142] https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md013.md

Check failure on line 9 in embedingModels/README.md

View workflow job for this annotation

GitHub Actions / build

Bare URL used 

embedingModels/README.md:9:39 MD034/no-bare-urls Bare URL used [Context: "https://huggingface.co/docs/hu..."] https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md034.md

Check failure on line 9 in embedingModels/README.md

View workflow job for this annotation

GitHub Actions / build

Bare URL used 

embedingModels/README.md:9:91 MD034/no-bare-urls Bare URL used [Context: "https://huggingface.co/blog/pa..."] https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md034.md
Expand All @@ -13,10 +14,13 @@ cd embeding_models
git clone [email protected]:intfloat/e5-large-v2
```

Check failure on line 15 in embedingModels/README.md

View workflow job for this annotation

GitHub Actions / build

Fenced code blocks should be surrounded by blank lines 

embedingModels/README.md:15 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md031.md
### Aleternativ for 1,2,3

Check failure on line 16 in embedingModels/README.md

View workflow job for this annotation

GitHub Actions / build

Headings should be surrounded by blank lines 

embedingModels/README.md:16 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "### Aleternativ for 1,2,3"] https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md022.md

copy evry flie form here: https://huggingface.co/intfloat/multilingual-e5-large/tree/main

Check failure on line 18 in embedingModels/README.md

View workflow job for this annotation

GitHub Actions / build

Bare URL used 

embedingModels/README.md:18:27 MD034/no-bare-urls Bare URL used [Context: "https://huggingface.co/intfloa..."] https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md034.md

#### IMPORTANT
#### IMPORTANT

keep file tree like this !!!

```sh
embeding_models
├── e5-large-v2
Expand All @@ -37,6 +41,7 @@ embeding_models
```

### NO GPU option

from `docker-compose.yml` remove:

```sh
Expand All @@ -49,9 +54,9 @@ from `docker-compose.yml` remove:
54 capabilities: [ gpu ]

```
#### <span style="color: red;">MOST IMPORTANT DONT PUSH THIS CHANGE !!!</span>

#### <span style="color: red;">MOST IMPORTANT DONT PUSH THIS CHANGE !!!</span>

ps. Patryk don't kill me :'( I want help to beginers.

#### Rest like in GPU option GLHF :)
#### Rest like in GPU option GLHF :)

0 comments on commit 9567025

Please sign in to comment.