Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,153 @@
+---
+tags:
+- summarization
+- mT5
+- llama-cpp
+- gguf-my-repo
+datasets:
+- csebuetnlp/xlsum
+language:
+- am
+- ar
+- az
+- bn
+- my
+- zh
+- en
+- fr
+- gu
+- ha
+- hi
+- ig
+- id
+- ja
+- rn
+- ko
+- ky
+- mr
+- ne
+- om
+- ps
+- fa
+- pcm
+- pt
+- pa
+- ru
+- gd
+- sr
+- si
+- so
+- es
+- sw
+- ta
+- te
+- th
+- ti
+- tr
+- uk
+- ur
+- uz
+- vi
+- cy
+- yo
+licenses:
+- cc-by-nc-sa-4.0
+widget:
+- text: Videos that say approved vaccines are dangerous and cause autism, cancer or
+    infertility are among those that will be taken down, the company said.  The policy
+    includes the termination of accounts of anti-vaccine influencers.  Tech giants
+    have been criticised for not doing more to counter false health information on
+    their sites.  In July, US President Joe Biden said social media platforms were
+    largely responsible for people's scepticism in getting vaccinated by spreading
+    misinformation, and appealed for them to address the issue.  YouTube, which is
+    owned by Google, said 130,000 videos were removed from its platform since last
+    year, when it implemented a ban on content spreading misinformation about Covid
+    vaccines.  In a blog post, the company said it had seen false claims about Covid
+    jabs "spill over into misinformation about vaccines in general". The new policy
+    covers long-approved vaccines, such as those against measles or hepatitis B.  "We're
+    expanding our medical misinformation policies on YouTube with new guidelines on
+    currently administered vaccines that are approved and confirmed to be safe and
+    effective by local health authorities and the WHO," the post said, referring to
+    the World Health Organization.
+base_model: csebuetnlp/mT5_multilingual_XLSum
+model-index:
+- name: csebuetnlp/mT5_multilingual_XLSum
+  results:
+  - task:
+      type: summarization
+      name: Summarization
+    dataset:
+      name: xsum
+      type: xsum
+      config: default
+      split: test
+    metrics:
+    - type: rouge
+      value: 36.5002
+      name: ROUGE-1
+      verified: true
+    - type: rouge
+      value: 13.934
+      name: ROUGE-2
+      verified: true
+    - type: rouge
+      value: 28.9876
+      name: ROUGE-L
+      verified: true
+    - type: rouge
+      value: 28.9958
+      name: ROUGE-LSUM
+      verified: true
+    - type: loss
+      value: 2.0674800872802734
+      name: loss
+      verified: true
+    - type: gen_len
+      value: 26.9733
+      name: gen_len
+      verified: true
+---
+
+# ar08/mT5_multilingual_XLSum-Q8_0-GGUF
+This model was converted to GGUF format from [`csebuetnlp/mT5_multilingual_XLSum`](https://huggingface.co/csebuetnlp/mT5_multilingual_XLSum) 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/csebuetnlp/mT5_multilingual_XLSum) 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 ar08/mT5_multilingual_XLSum-Q8_0-GGUF --hf-file mt5_multilingual_xlsum-q8_0.gguf -p "The meaning to life and the universe is"
+```
+
+### Server:
+```bash
+llama-server --hf-repo ar08/mT5_multilingual_XLSum-Q8_0-GGUF --hf-file mt5_multilingual_xlsum-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 ar08/mT5_multilingual_XLSum-Q8_0-GGUF --hf-file mt5_multilingual_xlsum-q8_0.gguf -p "The meaning to life and the universe is"
+```
+or 
+```
+./llama-server --hf-repo ar08/mT5_multilingual_XLSum-Q8_0-GGUF --hf-file mt5_multilingual_xlsum-q8_0.gguf -c 2048
+```