Skip to content

Commit eceaec9

Browse files
authored
Udpate openvino documentation (#741)
* udpate openvino documentation * rename section * add forward * style
1 parent 096d94b commit eceaec9

File tree

2 files changed

+78
-17
lines changed

2 files changed

+78
-17
lines changed

docs/source/inference.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,12 @@ As shown in the table below, each task is associated with a class enabling to au
2828
| `image-classification` | `OVModelForImageClassification` |
2929
| `feature-extraction` | `OVModelForFeatureExtraction` |
3030
| `fill-mask` | `OVModelForMaskedLM` |
31+
| `image-classification` | `OVModelForImageClassification` |
32+
| `audio-classification` | `OVModelForAudioClassification` |
3133
| `text-generation` | `OVModelForCausalLM` |
3234
| `text2text-generation` | `OVModelForSeq2SeqLM` |
35+
| `automatic-speech-recognition` | `OVModelForSpeechSeq2Seq` |
36+
| `image-to-text` | `OVModelForVision2Seq` |
3337

3438

3539
### Export

docs/source/reference_ov.mdx

+74-17
Original file line numberDiff line numberDiff line change
@@ -14,56 +14,113 @@ See the License for the specific language governing permissions and
1414
limitations under the License.
1515
-->
1616

17-
# Reference
17+
# Models
1818

19-
## OVModelForFeatureExtraction
19+
## Natural Language Processing
2020

21-
[[autodoc]] openvino.modeling.OVModelForFeatureExtraction
21+
The following classes are available for the following natural language processing tasks.
22+
23+
### OVModelForCausalLM
24+
25+
[[autodoc]] openvino.modeling_decoder.OVModelForCausalLM
26+
- forward
27+
- generate
2228

23-
## OVModelForMaskedLM
29+
### OVModelForMaskedLM
2430

2531
[[autodoc]] openvino.modeling.OVModelForMaskedLM
32+
- forward
33+
34+
### OVModelForSeq2SeqLM
35+
36+
[[autodoc]] openvino.modeling_seq2seq.OVModelForSeq2SeqLM
37+
- forward
2638

27-
## OVModelForQuestionAnswering
39+
### OVModelForQuestionAnswering
2840

2941
[[autodoc]] openvino.modeling.OVModelForQuestionAnswering
42+
- forward
3043

31-
## OVModelForSequenceClassification
44+
### OVModelForSequenceClassification
3245

3346
[[autodoc]] openvino.modeling.OVModelForSequenceClassification
47+
- forward
3448

35-
## OVModelForTokenClassification
49+
### OVModelForTokenClassification
3650

3751
[[autodoc]] openvino.modeling.OVModelForTokenClassification
52+
- forward
3853

39-
## OVModelForAudioClassification
54+
55+
## Audio
56+
57+
The following classes are available for the following audio tasks.
58+
59+
### OVModelForAudioClassification
4060

4161
[[autodoc]] openvino.modeling.OVModelForAudioClassification
62+
- forward
4263

43-
## OVModelForAudioFrameClassification
64+
### OVModelForAudioFrameClassification
4465

4566
[[autodoc]] openvino.modeling.OVModelForAudioFrameClassification
67+
- forward
4668

47-
## OVModelForCTC
69+
### OVModelForCTC
4870

4971
[[autodoc]] openvino.modeling.OVModelForCTC
72+
- forward
5073

51-
## OVModelForAudioXVector
74+
### OVModelForAudioXVector
5275

5376
[[autodoc]] openvino.modeling.OVModelForAudioXVector
77+
- forward
78+
79+
### OVModelForSpeechSeq2Seq
80+
81+
[[autodoc]] openvino.modeling_seq2seq.OVModelForSpeechSeq2Seq
82+
- forward
83+
84+
85+
## Computer Vision
5486

55-
## OVModelForImageClassification
87+
The following classes are available for the following computer vision tasks.
88+
89+
### OVModelForImageClassification
5690

5791
[[autodoc]] openvino.modeling.OVModelForImageClassification
92+
- forward
5893

59-
## OVModelForCausalLM
6094

61-
[[autodoc]] openvino.modeling_decoder.OVModelForCausalLM
95+
## Multimodal
6296

63-
## OVModelForSeq2SeqLM
97+
The following classes are available for the following multimodal tasks.
6498

65-
[[autodoc]] openvino.modeling_seq2seq.OVModelForSeq2SeqLM
99+
### OVModelForVision2Seq
100+
101+
[[autodoc]] openvino.modeling_seq2seq.OVModelForVision2Seq
102+
- forward
103+
104+
### OVModelForPix2Struct
105+
106+
[[autodoc]] openvino.modeling_seq2seq.OVModelForPix2Struct
107+
- forward
108+
109+
## Custom Tasks
110+
111+
### OVModelForCustomTasks
112+
113+
[[autodoc]] openvino.modeling.OVModelForCustomTasks
114+
- forward
115+
116+
### OVModelForFeatureExtraction
117+
118+
[[autodoc]] openvino.modeling.OVModelForFeatureExtraction
119+
- forward
120+
121+
122+
# Quantization
66123

67-
## OVQuantizer
124+
### OVQuantizer
68125

69126
[[autodoc]] openvino.quantization.OVQuantizer

0 commit comments

Comments
 (0)