trumancai
/

Revela-code-1b

@@ -1,202 +1,63 @@
 ---
 base_model: meta-llama/Llama-3.2-1B
 library_name: peft
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]
-### Framework versions
-- PEFT 0.13.2

 ---
 base_model: meta-llama/Llama-3.2-1B
 library_name: peft
+license: apache-2.0
+datasets:
+- trumancai/revela_code_training_corpus
+language:
+- en
+tags:
+- retrieval
+- code
 ---
+# Model Summary
+**Revela-code-3b** is a self-supervised code retriever built on the 3 B-parameter **LLaMA-3.2-3B** backbone.
+It was trained on 358 K batches of code-centric text (Stack Overflow, tutorials, API docs) using the Revela next-token-prediction + in-batch attention objective.
+Use it for code-search, question-answer navigation, or hybrid doc/code retrieval.
+- **Repository:** [TRUMANCFY/Revela](https://github.com/TRUMANCFY/Revela)
+- **Training Dataset:** [trumancai/revela_code_training_corpus](https://huggingface.co/datasets/trumancai/revela_code_training_corpus)
+# Other Links
+| Binary | Description |
+|:-------|:------------|
+| [trumancai/Revela-code-3b](https://huggingface.co/trumancai/Revela-code-3b) | 3 B-parameter code-retriever. |
+| [trumancai/Revela-code-1b](https://huggingface.co/trumancai/Revela-code-1b) | 1 B-parameter code-retriever. |
+| [trumancai/Revela-code-500M](https://huggingface.co/trumancai/Revela-code-500M) | 500 M-parameter code-retriever. |
+| [trumancai/Revela-3b](https://huggingface.co/trumancai/Revela-3b) | 3 B-parameter Wikipedia retriever. |
+| [trumancai/Revela-1b](https://huggingface.co/trumancai/Revela-1b) | 1 B-parameter Wikipedia retriever. |
+| [trumancai/Revela-500M](https://huggingface.co/trumancai/Revela-500M) | 500 M-parameter Wikipedia retriever. |
+| [trumancai/revela_code_training_corpus](https://huggingface.co/datasets/trumancai/revela_code_training_corpus) | Code training corpus. |
+| [trumancai/revela_training_corpus](https://huggingface.co/datasets/trumancai/revela_training_corpus) | Wikipedia training corpus. |
+# Usage
+```python
+from mteb.model_meta import ModelMeta
+from mteb.models.repllama_models import RepLLaMAWrapper, _loader
+import mteb, torch
+revela_code_llama_1b = ModelMeta(
+    loader=_loader(
+        RepLLaMAWrapper,
+        base_model_name_or_path="meta-llama/Llama-3.2-1B",
+        peft_model_name_or_path="trumancai/Revela-code-1b",
+        device_map="auto",
+        torch_dtype=torch.bfloat16,
+    ),
+    name="trumancai/Revela-code-1b",
+    languages=["eng_Latn"],
+    open_source=True,
+    revision="564997a2d9b1132085aa7906b0e89e9802fffee8",
+    release_date="2025-04-13",
+)
+model = revela_code_llama_1b.loader()
+mteb.MTEB(tasks=["AppsRetrieval"])
+    .run(model=model, output_folder="results/Revela-code-1b")
+```
+# License
+# Citation