Instructions to use Joaoffg/SHARE-4B-Base-2604 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use Joaoffg/SHARE-4B-Base-2604 with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="Joaoffg/SHARE-4B-Base-2604")# Load model directly from transformers import AutoTokenizer, AutoModelForCausalLM tokenizer = AutoTokenizer.from_pretrained("Joaoffg/SHARE-4B-Base-2604") model = AutoModelForCausalLM.from_pretrained("Joaoffg/SHARE-4B-Base-2604", device_map="auto") - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use Joaoffg/SHARE-4B-Base-2604 with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "Joaoffg/SHARE-4B-Base-2604" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "Joaoffg/SHARE-4B-Base-2604", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'Use Docker
docker model run hf.co/Joaoffg/SHARE-4B-Base-2604
- SGLang
How to use Joaoffg/SHARE-4B-Base-2604 with SGLang:
Install from pip and serve model
# Install SGLang from pip: pip install sglang # Start the SGLang server: python3 -m sglang.launch_server \ --model-path "Joaoffg/SHARE-4B-Base-2604" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "Joaoffg/SHARE-4B-Base-2604", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'Use Docker images
docker run --gpus all \ --shm-size 32g \ -p 30000:30000 \ -v ~/.cache/huggingface:/root/.cache/huggingface \ --env "HF_TOKEN=<secret>" \ --ipc=host \ lmsysorg/sglang:latest \ python3 -m sglang.launch_server \ --model-path "Joaoffg/SHARE-4B-Base-2604" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "Joaoffg/SHARE-4B-Base-2604", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }' - Docker Model Runner
How to use Joaoffg/SHARE-4B-Base-2604 with Docker Model Runner:
docker model run hf.co/Joaoffg/SHARE-4B-Base-2604
Add pipeline tag, library name, and paper link (#1)
Browse files- Add pipeline tag, library name, and paper link (211177b27f9e3588c47a6bad8e61e36b1c398536)
Co-authored-by: Niels Rogge <nielsr@users.noreply.huggingface.co>
README.md
CHANGED
|
@@ -1,18 +1,22 @@
|
|
| 1 |
---
|
| 2 |
-
license: other
|
| 3 |
-
license_name: rail-share
|
| 4 |
-
license_link: LICENSE
|
| 5 |
language:
|
| 6 |
- en
|
| 7 |
- nl
|
|
|
|
|
|
|
|
|
|
| 8 |
metrics:
|
| 9 |
- perplexity
|
|
|
|
|
|
|
| 10 |
---
|
| 11 |
|
| 12 |
# Model Card for SHARE-4B
|
| 13 |
|
| 14 |
SHARE-4B (Social-Humanities AI for Research and Education) is a 3.9-billion-parameter decoder-only causal language model pretrained exclusively on content relevant to the social sciences and humanities (SSH). It is intended as a domain-specific base model for SSH research and education, and is designed to be used through the MIRROR interface, which surfaces token-level surprisal rather than generating new text.
|
| 15 |
|
|
|
|
|
|
|
| 16 |
**Note:** This is a fully trained base (pretrained-only) model with no SFT, DPO, or RLHF. Due to its smaller size, a quantized version of SHARE-4B can be deployed on local machines with only CPU compute (e.g., student laptops), making it significantly more accessible and carbon-efficient than larger comparable models. This base model is not suitable for chat applications.
|
| 17 |
|
| 18 |
## Model Details
|
|
@@ -30,7 +34,7 @@ SHARE-4B is part of the first family of causal language models fully pretrained
|
|
| 30 |
### Model Sources
|
| 31 |
|
| 32 |
- **Repository:** https://github.com/Joaoffg/SHARE
|
| 33 |
-
- **Paper:** SHARE
|
| 34 |
- **Demo (MIRROR interface):** [Add link]
|
| 35 |
- **Contact:** ferreiragoncalves@eshcc.eur.nl
|
| 36 |
|
|
|
|
| 1 |
---
|
|
|
|
|
|
|
|
|
|
| 2 |
language:
|
| 3 |
- en
|
| 4 |
- nl
|
| 5 |
+
license: other
|
| 6 |
+
license_name: rail-share
|
| 7 |
+
license_link: LICENSE
|
| 8 |
metrics:
|
| 9 |
- perplexity
|
| 10 |
+
library_name: transformers
|
| 11 |
+
pipeline_tag: text-generation
|
| 12 |
---
|
| 13 |
|
| 14 |
# Model Card for SHARE-4B
|
| 15 |
|
| 16 |
SHARE-4B (Social-Humanities AI for Research and Education) is a 3.9-billion-parameter decoder-only causal language model pretrained exclusively on content relevant to the social sciences and humanities (SSH). It is intended as a domain-specific base model for SSH research and education, and is designed to be used through the MIRROR interface, which surfaces token-level surprisal rather than generating new text.
|
| 17 |
|
| 18 |
+
This model was introduced in the paper [SHARE: Social-Humanities AI for Research and Education](https://huggingface.co/papers/2604.11152).
|
| 19 |
+
|
| 20 |
**Note:** This is a fully trained base (pretrained-only) model with no SFT, DPO, or RLHF. Due to its smaller size, a quantized version of SHARE-4B can be deployed on local machines with only CPU compute (e.g., student laptops), making it significantly more accessible and carbon-efficient than larger comparable models. This base model is not suitable for chat applications.
|
| 21 |
|
| 22 |
## Model Details
|
|
|
|
| 34 |
### Model Sources
|
| 35 |
|
| 36 |
- **Repository:** https://github.com/Joaoffg/SHARE
|
| 37 |
+
- **Paper:** [SHARE: Social-Humanities AI for Research and Education](https://huggingface.co/papers/2604.11152)
|
| 38 |
- **Demo (MIRROR interface):** [Add link]
|
| 39 |
- **Contact:** ferreiragoncalves@eshcc.eur.nl
|
| 40 |
|