Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,218 @@
+---
+language:
+- af
+- ar
+- az
+- be
+- bg
+- bn
+- ca
+- ceb
+- cs
+- cy
+- da
+- de
+- el
+- en
+- es
+- et
+- eu
+- fa
+- fi
+- fr
+- gl
+- gu
+- he
+- hi
+- hr
+- ht
+- hu
+- hy
+- id
+- is
+- it
+- ja
+- jv
+- ka
+- kk
+- km
+- kn
+- ko
+- ky
+- lo
+- lt
+- lv
+- mk
+- ml
+- mn
+- mr
+- ms
+- my
+- ne
+- nl
+- 'no'
+- pa
+- pl
+- pt
+- qu
+- ro
+- ru
+- si
+- sk
+- sl
+- so
+- sq
+- sr
+- sv
+- sw
+- ta
+- te
+- th
+- tl
+- tr
+- uk
+- ur
+- vi
+- yo
+- zh
+library_name: sentence-transformers
+tags:
+- korean
+- sentence-transformers
+- transformers
+- multilingual
+- sentence-similarity
+- feature-extraction
+- llama-cpp
+- gguf-my-repo
+base_model: upskyy/bge-m3-korean
+datasets: []
+metrics:
+- pearson_cosine
+- spearman_cosine
+- pearson_manhattan
+- spearman_manhattan
+- pearson_euclidean
+- spearman_euclidean
+- pearson_dot
+- spearman_dot
+- pearson_max
+- spearman_max
+widget:
+- source_sentence: 이집트 군대가 형제애를 단속하다
+  sentences:
+  - 이집트의 군대가 무슬림 형제애를 단속하다
+  - 아르헨티나의 기예르모 코리아와 네덜란드의 마틴 버커크의 또 다른 준결승전도 매력적이다.
+  - 그것이 사실일 수도 있다고 생각하는 것은 재미있다.
+- source_sentence: 오, 그리고 다시 결혼은 근본적인 인권이라고 주장한다.
+  sentences:
+  - 특히 결혼은 근본적인 인권이라고 말한 후에.
+  - 해변에 있는 흑인과 그의 개...
+  - 이란은 핵 프로그램이 평화적인 목적을 위한 것이라고 주장한다
+- source_sentence: 두 사람이 계단을 올라가 건물 안으로 들어간다
+  sentences:
+  - 글쎄, 나는 우리가 꽤 나빠진 사이트 목록을 만들었고 일부를 정리해야한다는 일부 사이트에서 알았고 지금 법은 슈퍼 펀드이며 당신이 아무리간에
+    독성 폐기물을 일으킨 사람이라면 누구나 알고 있습니다. 결국 당신이 아는 사람은 누구나 땅에 손상을 입혔거나 모두가 기여해야한다는 것을 알고
+    있습니다. 그리고 우리가이 돈을 정리하기 위해 수퍼 펀드 거래를 가져 왔을 때 많은 돈을 벌었습니다. 모든 것을 꺼내서 다시 실행하면 다른
+    지역을 채울 수 있습니다. 음. 확실히 셔먼 시설과 같은 더 나은 솔루션을 가지고있는 것 같습니다. 기름 통에 넣은 다음 시멘트가 깔려있는
+    곳에서 밀봉하십시오.
+  - 한 사람이 계단을 올라간다.
+  - 두 사람이 함께 계단을 올라간다.
+- source_sentence: 그래, 내가 알아차린 적이 있어
+  sentences:
+  - 나는 알아차리지 못했다.
+  - 이것은 내가 영국의 아서 안데르센 사업부의 파트너인 짐 와디아를 아서 안데르센 경영진이 선택한 것보다 래리 웨인바흐를 안데르센 월드와이드의
+    경영 파트너로 승계하기 위해 안데르센 컨설팅 사업부(현재의 엑센츄어라고 알려져 있음)의 전 관리 파트너인 조지 샤힌에 대한 지지를 표명했을
+    때 가장 명백했다.
+  - 나는 메모했다.
+- source_sentence: 여자가 전화를 하는 동안 두 남자가 돈을 위해 악기를 연주한다.
+  sentences:
+  - 마이크에 대고 노래를 부르고 베이스를 연주하는 남자.
+  - 빨대를 사용하는 아이
+  - 돈을 위해 악기를 연주하는 사람들
+pipeline_tag: sentence-similarity
+model-index:
+- name: upskyy/bge-m3-korean
+  results:
+  - task:
+      type: semantic-similarity
+      name: Semantic Similarity
+    dataset:
+      name: sts dev
+      type: sts-dev
+    metrics:
+    - type: pearson_cosine
+      value: 0.8740181295716805
+      name: Pearson Cosine
+    - type: spearman_cosine
+      value: 0.8723737976913686
+      name: Spearman Cosine
+    - type: pearson_manhattan
+      value: 0.8593266961329962
+      name: Pearson Manhattan
+    - type: spearman_manhattan
+      value: 0.8687629058449345
+      name: Spearman Manhattan
+    - type: pearson_euclidean
+      value: 0.8597907936339472
+      name: Pearson Euclidean
+    - type: spearman_euclidean
+      value: 0.8693987158996017
+      name: Spearman Euclidean
+    - type: pearson_dot
+      value: 0.8683777071455441
+      name: Pearson Dot
+    - type: spearman_dot
+      value: 0.8665500024614361
+      name: Spearman Dot
+    - type: pearson_max
+      value: 0.8740181295716805
+      name: Pearson Max
+    - type: spearman_max
+      value: 0.8723737976913686
+      name: Spearman Max
+---
+
+# hongkeon/bge-m3-korean-Q8_0-GGUF
+This model was converted to GGUF format from [`upskyy/bge-m3-korean`](https://huggingface.co/upskyy/bge-m3-korean) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
+Refer to the [original model card](https://huggingface.co/upskyy/bge-m3-korean) for more details on the model.
+
+## Use with llama.cpp
+Install llama.cpp through brew (works on Mac and Linux)
+
+```bash
+brew install llama.cpp
+
+```
+Invoke the llama.cpp server or the CLI.
+
+### CLI:
+```bash
+llama-cli --hf-repo hongkeon/bge-m3-korean-Q8_0-GGUF --hf-file bge-m3-korean-q8_0.gguf -p "The meaning to life and the universe is"
+```
+
+### Server:
+```bash
+llama-server --hf-repo hongkeon/bge-m3-korean-Q8_0-GGUF --hf-file bge-m3-korean-q8_0.gguf -c 2048
+```
+
+Note: You can also use this checkpoint directly through the [usage steps](https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#usage) listed in the Llama.cpp repo as well.
+
+Step 1: Clone llama.cpp from GitHub.
+```
+git clone https://github.com/ggerganov/llama.cpp
+```
+
+Step 2: Move into the llama.cpp folder and build it with `LLAMA_CURL=1` flag along with other hardware-specific flags (for ex: LLAMA_CUDA=1 for Nvidia GPUs on Linux).
+```
+cd llama.cpp && LLAMA_CURL=1 make
+```
+
+Step 3: Run inference through the main binary.
+```
+./llama-cli --hf-repo hongkeon/bge-m3-korean-Q8_0-GGUF --hf-file bge-m3-korean-q8_0.gguf -p "The meaning to life and the universe is"
+```
+or 
+```
+./llama-server --hf-repo hongkeon/bge-m3-korean-Q8_0-GGUF --hf-file bge-m3-korean-q8_0.gguf -c 2048
+```