Ali-Forootani
commited on
Commit
•
d8f8a5c
1
Parent(s):
b68d6fd
Update README.md
Browse files
README.md
CHANGED
@@ -611,16 +611,16 @@ Model pushed successfully!
|
|
611 |
```
|
612 |
|
613 |
|
|
|
614 |
|
615 |
|
616 |
-
|
617 |
-
## License
|
618 |
|
619 |
This repository is licensed under the [MIT License](LICENSE).
|
620 |
|
621 |
-
|
622 |
|
623 |
-
For questions or issues, please contact [author](
|
624 |
|
625 |
---
|
626 |
|
@@ -628,206 +628,6 @@ This README provides a comprehensive guide to understanding and utilizing the sc
|
|
628 |
|
629 |
|
630 |
|
631 |
-
|
632 |
-
|
633 |
-
|
634 |
-
|
635 |
-
|
636 |
-
|
637 |
-
|
638 |
-
|
639 |
-
|
640 |
-
# Model Card for Model ID
|
641 |
-
|
642 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
643 |
-
|
644 |
-
|
645 |
-
|
646 |
-
## Model Details
|
647 |
-
|
648 |
-
### Model Description
|
649 |
-
|
650 |
-
<!-- Provide a longer summary of what this model is. -->
|
651 |
-
|
652 |
-
This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
|
653 |
-
|
654 |
-
- **Developed by:** [More Information Needed]
|
655 |
-
- **Funded by [optional]:** [More Information Needed]
|
656 |
-
- **Shared by [optional]:** [More Information Needed]
|
657 |
-
- **Model type:** [More Information Needed]
|
658 |
-
- **Language(s) (NLP):** [More Information Needed]
|
659 |
-
- **License:** [More Information Needed]
|
660 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
661 |
-
|
662 |
-
### Model Sources [optional]
|
663 |
-
|
664 |
-
<!-- Provide the basic links for the model. -->
|
665 |
-
|
666 |
-
- **Repository:** [More Information Needed]
|
667 |
-
- **Paper [optional]:** [More Information Needed]
|
668 |
-
- **Demo [optional]:** [More Information Needed]
|
669 |
-
|
670 |
-
## Uses
|
671 |
-
|
672 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
673 |
-
|
674 |
-
### Direct Use
|
675 |
-
|
676 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
677 |
-
|
678 |
-
[More Information Needed]
|
679 |
-
|
680 |
-
### Downstream Use [optional]
|
681 |
-
|
682 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
683 |
-
|
684 |
-
[More Information Needed]
|
685 |
-
|
686 |
-
### Out-of-Scope Use
|
687 |
-
|
688 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
689 |
-
|
690 |
-
[More Information Needed]
|
691 |
-
|
692 |
-
## Bias, Risks, and Limitations
|
693 |
-
|
694 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
695 |
-
|
696 |
-
[More Information Needed]
|
697 |
-
|
698 |
-
### Recommendations
|
699 |
-
|
700 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
701 |
-
|
702 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
703 |
-
|
704 |
-
## How to Get Started with the Model
|
705 |
-
|
706 |
-
Use the code below to get started with the model.
|
707 |
-
|
708 |
-
[More Information Needed]
|
709 |
-
|
710 |
-
## Training Details
|
711 |
-
|
712 |
-
### Training Data
|
713 |
-
|
714 |
-
<!-- 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. -->
|
715 |
-
|
716 |
-
[More Information Needed]
|
717 |
-
|
718 |
-
### Training Procedure
|
719 |
-
|
720 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
721 |
-
|
722 |
-
#### Preprocessing [optional]
|
723 |
-
|
724 |
-
[More Information Needed]
|
725 |
-
|
726 |
-
|
727 |
-
#### Training Hyperparameters
|
728 |
-
|
729 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
730 |
-
|
731 |
-
#### Speeds, Sizes, Times [optional]
|
732 |
-
|
733 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
734 |
-
|
735 |
-
[More Information Needed]
|
736 |
-
|
737 |
-
## Evaluation
|
738 |
-
|
739 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
740 |
-
|
741 |
-
### Testing Data, Factors & Metrics
|
742 |
-
|
743 |
-
#### Testing Data
|
744 |
-
|
745 |
-
<!-- This should link to a Dataset Card if possible. -->
|
746 |
-
|
747 |
-
[More Information Needed]
|
748 |
-
|
749 |
-
#### Factors
|
750 |
-
|
751 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
752 |
-
|
753 |
-
[More Information Needed]
|
754 |
-
|
755 |
-
#### Metrics
|
756 |
-
|
757 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
758 |
-
|
759 |
-
[More Information Needed]
|
760 |
-
|
761 |
-
### Results
|
762 |
-
|
763 |
-
[More Information Needed]
|
764 |
-
|
765 |
-
#### Summary
|
766 |
-
|
767 |
-
|
768 |
-
|
769 |
-
## Model Examination [optional]
|
770 |
-
|
771 |
-
<!-- Relevant interpretability work for the model goes here -->
|
772 |
-
|
773 |
-
[More Information Needed]
|
774 |
-
|
775 |
-
## Environmental Impact
|
776 |
-
|
777 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
778 |
-
|
779 |
-
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).
|
780 |
-
|
781 |
-
- **Hardware Type:** [More Information Needed]
|
782 |
-
- **Hours used:** [More Information Needed]
|
783 |
-
- **Cloud Provider:** [More Information Needed]
|
784 |
-
- **Compute Region:** [More Information Needed]
|
785 |
-
- **Carbon Emitted:** [More Information Needed]
|
786 |
-
|
787 |
-
## Technical Specifications [optional]
|
788 |
-
|
789 |
-
### Model Architecture and Objective
|
790 |
-
|
791 |
-
[More Information Needed]
|
792 |
-
|
793 |
-
### Compute Infrastructure
|
794 |
-
|
795 |
-
[More Information Needed]
|
796 |
-
|
797 |
-
#### Hardware
|
798 |
-
|
799 |
-
[More Information Needed]
|
800 |
-
|
801 |
-
#### Software
|
802 |
-
|
803 |
-
[More Information Needed]
|
804 |
-
|
805 |
-
## Citation [optional]
|
806 |
|
807 |
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
808 |
-
|
809 |
-
**BibTeX:**
|
810 |
-
|
811 |
-
[More Information Needed]
|
812 |
-
|
813 |
-
**APA:**
|
814 |
-
|
815 |
-
[More Information Needed]
|
816 |
-
|
817 |
-
## Glossary [optional]
|
818 |
-
|
819 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
820 |
-
|
821 |
-
[More Information Needed]
|
822 |
-
|
823 |
-
## More Information [optional]
|
824 |
-
|
825 |
-
[More Information Needed]
|
826 |
-
|
827 |
-
## Model Card Authors [optional]
|
828 |
-
|
829 |
-
[More Information Needed]
|
830 |
-
|
831 |
-
## Model Card Contact
|
832 |
-
|
833 |
-
[More Information Needed]
|
|
|
611 |
```
|
612 |
|
613 |
|
614 |
+
## This script is optimized to run on NVIDIA A100 GPUs. Specifically, the GPU resource used is: GPU: NVIDIA A100, 80GB
|
615 |
|
616 |
|
617 |
+
# License
|
|
|
618 |
|
619 |
This repository is licensed under the [MIT License](LICENSE).
|
620 |
|
621 |
+
# Contact
|
622 |
|
623 |
+
For questions or issues, please contact [author](aliforootan@ieee.org).
|
624 |
|
625 |
---
|
626 |
|
|
|
628 |
|
629 |
|
630 |
|
631 |
+
# Citation [optional]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
632 |
|
633 |
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|