Update README.md

README.md

@@ -16,9 +16,74 @@ tags:
 
 <!-- Provide a quick summary of what the model is/does. -->
 
+## Model Details
 
+- `Tokenizer`
+```py
+from transformers import PreTrainedTokenizerFast
+
+# Assuming your custom tokenizer is `tokenizer`
+wrapped_tokenizer = PreTrainedTokenizerFast(
+    tokenizer_object=tokenizer,
+    bos_token="[BOS]",  # Replace with your special tokens
+    eos_token="[EOS]",  # Replace with your special tokens
+    unk_token="[UNK]",
+    pad_token="[PAD]"
+)
 
-## Model Details
+# Ensure padding is applied to the right side (used in causal language modeling)
+wrapped_tokenizer.padding_side = "right"
+
+```
+
+- `Model`
+```py
+from transformers import LlamaConfig, LlamaForCausalLM
+
+config = LlamaConfig(
+    vocab_size=len(wrapped_tokenizer),  # Get vocab size from the wrapped tokenizer
+    hidden_size=512,                    # Adjust model size as needed
+    intermediate_size=1024,
+    num_hidden_layers=8,                # Set number of layers and heads
+    num_attention_heads=8,
+    max_position_embeddings=512,
+    rms_norm_eps=1e-6,
+    initializer_range=0.02,
+    use_cache=True,
+    pad_token_id=wrapped_tokenizer.pad_token_id,
+    bos_token_id=wrapped_tokenizer.bos_token_id,
+    eos_token_id=wrapped_tokenizer.eos_token_id,
+)
+
+model = LlamaForCausalLM(config)
+```
+
+- `Trainer`
+```py
+from transformers import TrainingArguments, Trainer
+
+# Define training arguments
+training_args = TrainingArguments(
+    output_dir="kongo-llama",           # Output directory for model and checkpoints
+    num_train_epochs=1,
+    per_device_train_batch_size=8,
+    learning_rate=5e-5,
+    warmup_steps=500,
+    weight_decay=0.01,
+    logging_dir="./logs",
+    logging_steps=10,
+    save_steps=1000,
+)
+
+
+trainer = Trainer(
+    model=model,                          # Your model instance
+    args=training_args,                   # Training arguments
+    train_dataset=dataset,                # Tokenized dataset with input_ids and labels
+    tokenizer=wrapped_tokenizer,          # Wrapped tokenizer
+    data_collator=data_collator,          # Data collator for causal language modeling
+)
+````
 
 ### Model Description
 
@@ -66,164 +131,3 @@ generated_ids = model.generate(
 generated_text = wrapped_tokenizer.batch_decode(generated_ids, skip_special_tokens=True)
 print(generated_text)
 ```
-
-### 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]