Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the README when using PEFT #594

Merged
merged 5 commits into from
Jun 19, 2023

Conversation

pacman100
Copy link
Contributor

@pacman100 pacman100 commented Jun 17, 2023

What does this PR do?

  1. Adds peft library tag
  2. Adds peft version
  3. Adds quantization information if it was used

Code:

trainer.push_to_hub()
trainer.model.push_to_hub(trainer.repo.local_dir)

Sample Output:

model: https://huggingface.co/smangrul/results

---
license: apache-2.0
tags:
- generated_from_trainer
model-index:
- name: results
  results: []
library_name: peft
---

<!-- This model card has been generated automatically according to the information the Trainer had access to. You
should probably proofread and complete it, then remove this comment. -->

# results

This model is a fine-tuned version of [tiiuae/falcon-7b](https://huggingface.co/tiiuae/falcon-7b) on an unknown dataset.

## Model description

More information needed

## Intended uses & limitations

More information needed

## Training and evaluation data

More information needed

## Training procedure


The following `bitsandbytes` quantization config was used during training:
- load_in_8bit: False
- load_in_4bit: True
- llm_int8_threshold: 6.0
- llm_int8_skip_modules: None
- llm_int8_enable_fp32_cpu_offload: False
- llm_int8_has_fp16_weight: False
- bnb_4bit_quant_type: nf4
- bnb_4bit_use_double_quant: False
- bnb_4bit_compute_dtype: bfloat16
### Training hyperparameters

The following hyperparameters were used during training:
- learning_rate: 0.0002
- train_batch_size: 2560
- eval_batch_size: 40
- seed: 42
- gradient_accumulation_steps: 4
- total_train_batch_size: 10240
- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
- lr_scheduler_type: constant
- lr_scheduler_warmup_ratio: 0.03
- training_steps: 1875

### Framework versions

- PEFT 0.4.0.dev0
- Transformers 4.31.0.dev0
- Pytorch 2.0.1+cu117
- Datasets 2.9.0
- Tokenizers 0.13.3

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Jun 17, 2023

The documentation is not available anymore as the PR was closed or merged.

@pacman100 pacman100 changed the title add logic Improve the README when using PEFT Jun 17, 2023
@pacman100 pacman100 marked this pull request as ready for review June 17, 2023 06:41
@pacman100 pacman100 requested a review from younesbelkada June 17, 2023 06:41
Copy link
Contributor

@younesbelkada younesbelkada left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super nice and clean 🔥 Thanks a lot @pacman100 !

@pacman100 pacman100 merged commit 08cb3dd into main Jun 19, 2023
@pacman100 pacman100 deleted the smangrul/add-update-model-card-util branch February 20, 2024 05:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants