Update README.md
Browse files
README.md
CHANGED
@@ -7,11 +7,13 @@ metrics:
|
|
7 |
model-index:
|
8 |
- name: codet5-base-Generate_Docstrings_for_Python-Condensed
|
9 |
results: []
|
|
|
|
|
|
|
|
|
|
|
10 |
---
|
11 |
|
12 |
-
<!-- This model card has been generated automatically according to the information the Trainer had access to. You
|
13 |
-
should probably proofread and complete it, then remove this comment. -->
|
14 |
-
|
15 |
# codet5-base-Generate_Docstrings_for_Python-Condensed
|
16 |
|
17 |
This model is a fine-tuned version of [Salesforce/codet5-base](https://huggingface.co/Salesforce/codet5-base) on the None dataset.
|
@@ -25,15 +27,17 @@ It achieves the following results on the evaluation set:
|
|
25 |
|
26 |
## Model description
|
27 |
|
28 |
-
|
|
|
|
|
29 |
|
30 |
## Intended uses & limitations
|
31 |
|
32 |
-
|
33 |
|
34 |
## Training and evaluation data
|
35 |
|
36 |
-
|
37 |
|
38 |
## Training procedure
|
39 |
|
@@ -61,4 +65,4 @@ The following hyperparameters were used during training:
|
|
61 |
- Transformers 4.27.4
|
62 |
- Pytorch 2.0.0
|
63 |
- Datasets 2.11.0
|
64 |
-
- Tokenizers 0.13.3
|
|
|
7 |
model-index:
|
8 |
- name: codet5-base-Generate_Docstrings_for_Python-Condensed
|
9 |
results: []
|
10 |
+
datasets:
|
11 |
+
- calum/the-stack-smol-python-docstrings
|
12 |
+
language:
|
13 |
+
- en
|
14 |
+
pipeline_tag: text2text-generation
|
15 |
---
|
16 |
|
|
|
|
|
|
|
17 |
# codet5-base-Generate_Docstrings_for_Python-Condensed
|
18 |
|
19 |
This model is a fine-tuned version of [Salesforce/codet5-base](https://huggingface.co/Salesforce/codet5-base) on the None dataset.
|
|
|
27 |
|
28 |
## Model description
|
29 |
|
30 |
+
This model predicts the docstring (the output) for a function (the input).
|
31 |
+
|
32 |
+
For more information on how it was created, check out the following link: https://github.com/DunnBC22/NLP_Projects/blob/main/Generate%20Docstrings/Smol%20Dataset/Code_T5_Project-Base%20Checkpoint.ipynb
|
33 |
|
34 |
## Intended uses & limitations
|
35 |
|
36 |
+
This model is intended to demonstrate my ability to solve a complex problem using technology.
|
37 |
|
38 |
## Training and evaluation data
|
39 |
|
40 |
+
Dataset Source: calum/the-stack-smol-python-docstrings (from HuggingFace Datasets; https://huggingface.co/datasets/calum/the-stack-smol-python-docstrings)
|
41 |
|
42 |
## Training procedure
|
43 |
|
|
|
65 |
- Transformers 4.27.4
|
66 |
- Pytorch 2.0.0
|
67 |
- Datasets 2.11.0
|
68 |
+
- Tokenizers 0.13.3
|