Update README.md
Browse files
README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
| 1 |
[# NCU Smart LLM (phi2-ncu) β Smart LLM Fine-tuned for NCU Tasks
|
| 2 |
|
| 3 |
<p align="center">
|
| 4 |
-
<img src="https://huggingface.co/pranav2711/phi2-ncu-model/resolve/main/NCU-Logo.png" alt="NCU Logo" width="
|
| 5 |
</p>
|
| 6 |
|
| 7 |
> A lightweight, instruction-tuned version of [Microsoft's Phi-2](https://huggingface.co/microsoft/phi-2), customized for use cases and conversations related to The NorthCap University (NCU), India.
|
|
@@ -9,17 +9,17 @@
|
|
| 9 |
|
| 10 |
---
|
| 11 |
|
| 12 |
-
##
|
| 13 |
|
| 14 |
-
*
|
| 15 |
-
*
|
| 16 |
-
*
|
| 17 |
-
*
|
| 18 |
-
*
|
| 19 |
|
| 20 |
---
|
| 21 |
|
| 22 |
-
##
|
| 23 |
|
| 24 |
| Platform | Access Method |
|
| 25 |
| ------------------ | --------------------------------------------------------------------------- |
|
|
@@ -41,7 +41,7 @@
|
|
| 41 |
|
| 42 |
---
|
| 43 |
|
| 44 |
-
##
|
| 45 |
|
| 46 |
```bash
|
| 47 |
pip install transformers accelerate peft
|
|
@@ -71,11 +71,11 @@ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
|
|
| 71 |
|
| 72 |
---
|
| 73 |
|
| 74 |
-
##
|
| 75 |
|
| 76 |
> This works only **locally** via `ollama create` and **not yet shareable** as public Ollama model hub is restricted.
|
| 77 |
|
| 78 |
-
###
|
| 79 |
|
| 80 |
```
|
| 81 |
phi2-ncu/
|
|
@@ -89,7 +89,7 @@ phi2-ncu/
|
|
| 89 |
βββ merges.txt
|
| 90 |
```
|
| 91 |
|
| 92 |
-
###
|
| 93 |
|
| 94 |
```bash
|
| 95 |
ollama create phi2-ncu -f Modelfile
|
|
@@ -98,7 +98,7 @@ ollama run phi2-ncu
|
|
| 98 |
|
| 99 |
---
|
| 100 |
|
| 101 |
-
##
|
| 102 |
|
| 103 |
```json
|
| 104 |
{
|
|
@@ -121,7 +121,7 @@ You can collect your degree certificate...
|
|
| 121 |
|
| 122 |
---
|
| 123 |
|
| 124 |
-
##
|
| 125 |
|
| 126 |
* Used `LoRA` with rank=8, alpha=16
|
| 127 |
* Tokenized to max length = 512
|
|
@@ -131,17 +131,17 @@ You can collect your degree certificate...
|
|
| 131 |
|
| 132 |
---
|
| 133 |
|
| 134 |
-
##
|
| 135 |
|
| 136 |
Apache 2.0
|
| 137 |
|
| 138 |
-
##
|
| 139 |
|
| 140 |
**The NorthCap University**, Gurugram (formerly ITM University), is a multidisciplinary university with programs in engineering, management, law, and sciences.
|
| 141 |
|
| 142 |
This model was created as part of a research initiative to explore AI for academic services, campus automation, and local LLM deployments.
|
| 143 |
|
| 144 |
-
##
|
| 145 |
|
| 146 |
Have better FAQs or data? Want to train on your college corpus? Fork the repo or raise a PR at:
|
| 147 |
|
|
|
|
| 1 |
[# NCU Smart LLM (phi2-ncu) β Smart LLM Fine-tuned for NCU Tasks
|
| 2 |
|
| 3 |
<p align="center">
|
| 4 |
+
<img src="https://huggingface.co/pranav2711/phi2-ncu-model/resolve/main/NCU-Logo.png" alt="NCU Logo" width="240"/>
|
| 5 |
</p>
|
| 6 |
|
| 7 |
> A lightweight, instruction-tuned version of [Microsoft's Phi-2](https://huggingface.co/microsoft/phi-2), customized for use cases and conversations related to The NorthCap University (NCU), India.
|
|
|
|
| 9 |
|
| 10 |
---
|
| 11 |
|
| 12 |
+
## Highlights
|
| 13 |
|
| 14 |
+
* **Base Model:** `microsoft/phi-2` (2.7B parameters)
|
| 15 |
+
* **Fine-tuned Using:** Low-Rank Adaptation (LoRA) + PEFT + Hugging Face Transformers
|
| 16 |
+
* **Dataset:** University questions, FAQs, policies, academic support queries, smart campus data
|
| 17 |
+
* **Training Environment:** Google Colab (T4 GPU), 4 epochs, batch size 1, no FP16
|
| 18 |
+
* **Final Format:** Full model weights (`.safetensors`) + tokenizer
|
| 19 |
|
| 20 |
---
|
| 21 |
|
| 22 |
+
## Model Access
|
| 23 |
|
| 24 |
| Platform | Access Method |
|
| 25 |
| ------------------ | --------------------------------------------------------------------------- |
|
|
|
|
| 41 |
|
| 42 |
---
|
| 43 |
|
| 44 |
+
## How to Use Locally (Hugging Face Transformers)
|
| 45 |
|
| 46 |
```bash
|
| 47 |
pip install transformers accelerate peft
|
|
|
|
| 71 |
|
| 72 |
---
|
| 73 |
|
| 74 |
+
## How to Use with Ollama (Offline)
|
| 75 |
|
| 76 |
> This works only **locally** via `ollama create` and **not yet shareable** as public Ollama model hub is restricted.
|
| 77 |
|
| 78 |
+
### Folder Structure
|
| 79 |
|
| 80 |
```
|
| 81 |
phi2-ncu/
|
|
|
|
| 89 |
βββ merges.txt
|
| 90 |
```
|
| 91 |
|
| 92 |
+
### Steps
|
| 93 |
|
| 94 |
```bash
|
| 95 |
ollama create phi2-ncu -f Modelfile
|
|
|
|
| 98 |
|
| 99 |
---
|
| 100 |
|
| 101 |
+
## Example Dataset Format (Used for Training)
|
| 102 |
|
| 103 |
```json
|
| 104 |
{
|
|
|
|
| 121 |
|
| 122 |
---
|
| 123 |
|
| 124 |
+
## Training Strategy
|
| 125 |
|
| 126 |
* Used `LoRA` with rank=8, alpha=16
|
| 127 |
* Tokenized to max length = 512
|
|
|
|
| 131 |
|
| 132 |
---
|
| 133 |
|
| 134 |
+
## License
|
| 135 |
|
| 136 |
Apache 2.0
|
| 137 |
|
| 138 |
+
## About NCU
|
| 139 |
|
| 140 |
**The NorthCap University**, Gurugram (formerly ITM University), is a multidisciplinary university with programs in engineering, management, law, and sciences.
|
| 141 |
|
| 142 |
This model was created as part of a research initiative to explore AI for academic services, campus automation, and local LLM deployments.
|
| 143 |
|
| 144 |
+
## Contribute
|
| 145 |
|
| 146 |
Have better FAQs or data? Want to train on your college corpus? Fork the repo or raise a PR at:
|
| 147 |
|