ndupuis commited on
Commit
5432bad
·
1 Parent(s): a8de3b7

Update model card

Browse files
Files changed (1) hide show
  1. README.md +10 -10
README.md CHANGED
@@ -13,7 +13,7 @@ tags:
13
  - granite
14
  - qiskit
15
  model-index:
16
- - name: granite-8b-qiskit
17
  results:
18
  - task:
19
  type: text-generation
@@ -23,7 +23,7 @@ model-index:
23
  metrics:
24
  - name: pass@1
25
  type: pass@1
26
- value: 45.69
27
  verified: false
28
  - task:
29
  type: text-generation
@@ -33,21 +33,21 @@ model-index:
33
  metrics:
34
  - name: pass@1
35
  type: pass@1
36
- value: 58.53
37
  verified: false
38
  ---
39
 
40
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/5e6f94a5d4cd9779932a7610/rkvd1vRSwF0pIpcHAd5Ai.png)
41
 
42
- # granite-8b-qiskit
43
 
44
  ## Model Summary
45
 
46
- **granite-8b-qiskit** is a 8B parameter model extend pretrained and fine tuned on top of [granite-8b-code-base](https://huggingface.co/ibm-granite/granite-8b-code-base-4k) using Qiskit code and instruction data to improve capabilities at writing high-quality and non-deprecated Qiskit code. We used only data with the following licenses: Apache 2.0, MIT, the Unlicense, Mulan PSL Version 2, BSD-2, BSD-3, and Creative Commons Attribution 4.0.
47
 
48
  - **Developers:** IBM Quantum & IBM Research
49
  - **Related Papers:** [Qiskit Code Assistant: Training LLMs for generating Quantum Computing Code](https://arxiv.org/abs/2405.19495) and [Qiskit HumanEval: An Evaluation Benchmark For Quantum Code Generative Models](https://arxiv.org/abs/2406.14712)
50
- - **Release Date**: November 12th, 2024
51
  - **License:** apache-2.0
52
 
53
  ## Usage
@@ -58,13 +58,13 @@ This model is designed for generating quantum computing code using Qiskit. Both
58
 
59
  ### Generation
60
 
61
- This is a simple example of how to use **granite-8b-qiskit** model.
62
 
63
  ```python
64
  import torch
65
  from transformers import AutoModelForCausalLM, AutoTokenizer
66
  device = "cuda" # or "cpu"
67
- model_path = "qiskit/granite-8b-qiskit"
68
  tokenizer = AutoTokenizer.from_pretrained(model_path)
69
  # drop device_map if running on CPU
70
  model = AutoModelForCausalLM.from_pretrained(model_path, device_map=device)
@@ -96,8 +96,8 @@ for i in output:
96
 
97
  ## Infrastructure
98
 
99
- We trained **granite-8b-qiskit** using IBM's super computing cluster (Vela) using NVIDIA A100 GPUs.
100
 
101
  ## Ethical Considerations and Limitations
102
 
103
- The use of Large Language Models involves risks and ethical considerations people must be aware of. Regarding code generation, caution is urged against complete reliance on specific code models for crucial decisions or impactful information as the generated code is not guaranteed to work as intended. **granite-8b-qiskit** model is not the exception in this regard. Even though this model is suited for multiple code-related tasks, it has not undergone any safety alignment, there it may produce problematic outputs. Additionally, it remains uncertain whether smaller models might exhibit increased susceptibility to hallucination in generation scenarios by copying source code verbatim from the training dataset due to their reduced sizes and memorization capacities. This aspect is currently an active area of research, and we anticipate more rigorous exploration, comprehension, and mitigations in this domain. Regarding ethics, a latent risk associated with all Large Language Models is their malicious utilization. We urge the community to use **granite-8b-qiskit** model with ethical intentions and in a responsible way.
 
13
  - granite
14
  - qiskit
15
  model-index:
16
+ - name: granite-8b-rc-0.10
17
  results:
18
  - task:
19
  type: text-generation
 
23
  metrics:
24
  - name: pass@1
25
  type: pass@1
26
+ value: 34.43
27
  verified: false
28
  - task:
29
  type: text-generation
 
33
  metrics:
34
  - name: pass@1
35
  type: pass@1
36
+ value: 59.14
37
  verified: false
38
  ---
39
 
40
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/5e6f94a5d4cd9779932a7610/rkvd1vRSwF0pIpcHAd5Ai.png)
41
 
42
+ # granite-8b-rc-0.10
43
 
44
  ## Model Summary
45
 
46
+ **granite-8b-rc-0.10** is a 8B parameter model extend pretrained and fine tuned on top of [granite-8b-code-base](https://huggingface.co/ibm-granite/granite-8b-code-base-4k) using Qiskit code and instruction data to improve capabilities at writing high-quality and non-deprecated Qiskit code. We used only data with the following licenses: Apache 2.0, MIT, the Unlicense, Mulan PSL Version 2, BSD-2, BSD-3, and Creative Commons Attribution 4.0.
47
 
48
  - **Developers:** IBM Quantum & IBM Research
49
  - **Related Papers:** [Qiskit Code Assistant: Training LLMs for generating Quantum Computing Code](https://arxiv.org/abs/2405.19495) and [Qiskit HumanEval: An Evaluation Benchmark For Quantum Code Generative Models](https://arxiv.org/abs/2406.14712)
50
+ - **Release Date**: February 14th, 2025
51
  - **License:** apache-2.0
52
 
53
  ## Usage
 
58
 
59
  ### Generation
60
 
61
+ This is a simple example of how to use **granite-8b-rc-0.10** model.
62
 
63
  ```python
64
  import torch
65
  from transformers import AutoModelForCausalLM, AutoTokenizer
66
  device = "cuda" # or "cpu"
67
+ model_path = "qiskit/granite-8b-rc-0.10"
68
  tokenizer = AutoTokenizer.from_pretrained(model_path)
69
  # drop device_map if running on CPU
70
  model = AutoModelForCausalLM.from_pretrained(model_path, device_map=device)
 
96
 
97
  ## Infrastructure
98
 
99
+ We trained **granite-8b-rc-0.10** using IBM's super computing cluster (Vela) using NVIDIA A100 GPUs.
100
 
101
  ## Ethical Considerations and Limitations
102
 
103
+ The use of Large Language Models involves risks and ethical considerations people must be aware of. Regarding code generation, caution is urged against complete reliance on specific code models for crucial decisions or impactful information as the generated code is not guaranteed to work as intended. **granite-8b-rc-0.10** model is not the exception in this regard. Even though this model is suited for multiple code-related tasks, it has not undergone any safety alignment, there it may produce problematic outputs. Additionally, it remains uncertain whether smaller models might exhibit increased susceptibility to hallucination in generation scenarios by copying source code verbatim from the training dataset due to their reduced sizes and memorization capacities. This aspect is currently an active area of research, and we anticipate more rigorous exploration, comprehension, and mitigations in this domain. Regarding ethics, a latent risk associated with all Large Language Models is their malicious utilization. We urge the community to use **granite-8b-rc-0.10** model with ethical intentions and in a responsible way.