justinthelaw commited on
Commit
49cd419
1 Parent(s): 6e3aeb9

Docs(README): Usage and disclaimer edits

Browse files
Files changed (1) hide show
  1. README.md +3 -9
README.md CHANGED
@@ -35,13 +35,7 @@ widget:
35
 
36
  # Opera Bullet Interpreter
37
 
38
- **_DISCLAIMER_**: Use of the model using Hugging Face's Inference API widget, beside this card, on the Hugging Face website will produce poor results. Please see "[How to Get Started with the Model](#How-to-Get-Started-with-the-Model)" for more details on how to use this model properly.
39
-
40
- An unofficial United States Air Force and Space Force performance statement "translation" model. Takes a properly formatted performance statement, also known as a "bullet," as an input and outputs a long-form sentence, using plain english, describing the accomplishments captured within the bullet.
41
-
42
- This checkpoint is a fine-tuned version of the LaMini-Flan-T5-783M, using the justinthelaw/opera-bullet-completions (private) dataset.
43
-
44
- To learn more about this project, please visit the [Opera GitHub Repository](https://github.com/justinthelaw/opera).
45
 
46
  # Table of Contents
47
 
@@ -77,8 +71,6 @@ This is a fine-tuned version of the LaMini-Flan-T5-783M, using the justinthelaw/
77
 
78
  # Uses
79
 
80
- **_DISCLAIMER_**: Use of the model using Hugging Face's Inference API widget, beside this card, on the Hugging Face website will produce poor results. Please see "[How to Get Started with the Model](#How-to-Get-Started-with-the-Model)" for more details on how to use this model properly.
81
-
82
  ## Direct Use
83
 
84
  Used to programmatically produce training data for Opera's Bullet Forge (see GitHub repository for details).
@@ -100,6 +92,8 @@ Used to quickly interpret bullets written by Airman (Air Force) or Guardians (Sp
100
 
101
  ## Out-of-Scope Use
102
 
 
 
103
  Generating bullets from long-form, plain English sentences. General NLP functionality.
104
 
105
  # Bias, Risks, and Limitations
 
35
 
36
  # Opera Bullet Interpreter
37
 
38
+ **_DISCLAIMER_**: Use of the model using Hugging Face's Inference API widget will produce cut-off results. Please see "[How to Get Started with the Model](#How-to-Get-Started-with-the-Model)" for more details on how to use this model properly.
 
 
 
 
 
 
39
 
40
  # Table of Contents
41
 
 
71
 
72
  # Uses
73
 
 
 
74
  ## Direct Use
75
 
76
  Used to programmatically produce training data for Opera's Bullet Forge (see GitHub repository for details).
 
92
 
93
  ## Out-of-Scope Use
94
 
95
+ Use of the model using Hugging Face's Inference API widget will produce cut-off results. Please see "[How to Get Started with the Model](#How-to-Get-Started-with-the-Model)" for more details on how to use this model properly. This Hugging Face inference pipeline behavior may be refactored in the future.
96
+
97
  Generating bullets from long-form, plain English sentences. General NLP functionality.
98
 
99
  # Bias, Risks, and Limitations