Auto-generating sphinx docs

Author: pytorchbot

main/javadoc/allclasses.html

@@ -37,14 +37,6 @@ <h1 class="bar">All Classes</h1>
 
             <li><a href=org/pytorch/executorch/annotations/Experimental.html>Experimental</a></li>
 
-            <li><a href=org/pytorch/executorch/extension/llm/LlmCallback.html>LlmCallback</a></li>
-        
-            <li><a href=org/pytorch/executorch/extension/llm/LlmGenerationConfig.html>LlmGenerationConfig</a></li>
-        
-            <li><a href=org/pytorch/executorch/extension/llm/LlmModule.html>LlmModule</a></li>
-        
-            <li><a href=org/pytorch/executorch/extension/llm/LlmModuleConfig.html>LlmModuleConfig</a></li>
-        
             <li><a href=org/pytorch/executorch/training/SGD.html>SGD</a></li>
 
             <li><a href=org/pytorch/executorch/training/TrainingModule.html>TrainingModule</a></li>
@@ -54,6 +46,14 @@ <h1 class="bar">All Classes</h1>
             <li><a href=org/pytorch/executorch/extension/asr/AsrModule.html>AsrModule</a></li>
 
             <li><a href=org/pytorch/executorch/extension/asr/AsrTranscribeConfig.html>AsrTranscribeConfig</a></li>
+        
+            <li><a href=org/pytorch/executorch/extension/llm/LlmCallback.html>LlmCallback</a></li>
+        
+            <li><a href=org/pytorch/executorch/extension/llm/LlmGenerationConfig.html>LlmGenerationConfig</a></li>
+        
+            <li><a href=org/pytorch/executorch/extension/llm/LlmModule.html>LlmModule</a></li>
+        
+            <li><a href=org/pytorch/executorch/extension/llm/LlmModuleConfig.html>LlmModuleConfig</a></li>
         </ul>
 </main>
 </body>

main/javadoc/element-list

@@ -3,7 +3,10 @@ $dokka.linkExtension:html
 $dokka.location:org.pytorch.executorch.extension.asr/AsrModule.Companion///PointingToDeclaration/org/pytorch/executorch/extension/asr/AsrModule.Companion.html
 $dokka.location:org.pytorch.executorch.extension.asr/AsrTranscribeConfig.Builder///PointingToDeclaration/org/pytorch/executorch/extension/asr/AsrTranscribeConfig.Builder.html
 $dokka.location:org.pytorch.executorch.extension.llm/LlmGenerationConfig.Builder///PointingToDeclaration/org/pytorch/executorch/extension/llm/LlmGenerationConfig.Builder.html
+$dokka.location:org.pytorch.executorch.extension.llm/LlmGenerationConfig.Companion///PointingToDeclaration/org/pytorch/executorch/extension/llm/LlmGenerationConfig.Companion.html
+$dokka.location:org.pytorch.executorch.extension.llm/LlmModule.Companion///PointingToDeclaration/org/pytorch/executorch/extension/llm/LlmModule.Companion.html
 $dokka.location:org.pytorch.executorch.extension.llm/LlmModuleConfig.Builder///PointingToDeclaration/org/pytorch/executorch/extension/llm/LlmModuleConfig.Builder.html
+$dokka.location:org.pytorch.executorch.extension.llm/LlmModuleConfig.Companion///PointingToDeclaration/org/pytorch/executorch/extension/llm/LlmModuleConfig.Companion.html
 $dokka.location:org.pytorch.executorch/ExecutorchRuntimeException.ExecutorchInvalidArgumentException///PointingToDeclaration/org/pytorch/executorch/ExecutorchRuntimeException.ExecutorchInvalidArgumentException.html
 org.pytorch.executorch
 org.pytorch.executorch.annotations

main/javadoc/index-files/index-10.html

@@ -152,7 +152,7 @@ <h2 class="title">L</h2>
 
 
             </dt>
-            <dd>Callback interface for Llama model.</dd>
+            <dd>Callback interface for Llm model.</dd>
 
 
             <dt>
@@ -181,6 +181,19 @@ <h2 class="title">L</h2>
             <dd>Builder class for constructing LlmGenerationConfig instances.</dd>
 
 
+            <dt>
+                
+                <span class="memberNameLink">
+                
+                    <a href="../org/pytorch/executorch/extension/llm/LlmGenerationConfig.Companion.html">LlmGenerationConfig.Companion</a>
+                
+                </span> - class in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmGenerationConfig.html>LlmGenerationConfig</a>
+                
+
+            </dt>
+            <dd>&nbsp;</dd>
+
+        
             <dt>
 
                 <span class="memberNameLink">
@@ -194,6 +207,19 @@ <h2 class="title">L</h2>
             <dd>LlmModule is a wrapper around the Executorch LLM.</dd>
 
 
+            <dt>
+                
+                <span class="memberNameLink">
+                
+                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.Companion.html">LlmModule.Companion</a>
+                
+                </span> - class in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModule.html>LlmModule</a>
+                
+
+            </dt>
+            <dd>&nbsp;</dd>
+
+        
             <dt>
 
                 <span class="memberNameLink">
@@ -224,20 +250,20 @@ <h2 class="title">L</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/Module.html#load(String,int)">load(String,int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmModuleConfig.Companion.html">LlmModuleConfig.Companion</a>
 
-                </span> - function in org.pytorch.executorch.<a href=../org/pytorch/executorch/Module.html>Module</a>
+                </span> - class in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModuleConfig.html>LlmModuleConfig</a>
 
 
             </dt>
-            <dd>Loads a serialized ExecuTorch module from the specified path on the disk.</dd>
+            <dd>&nbsp;</dd>
 
 
             <dt>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/Module.html#load(String,int,int)">load(String,int,int)</a>
+                    <a href="../org/pytorch/executorch/Module.html#load(String,int)">load(String,int)</a>
 
                 </span> - function in org.pytorch.executorch.<a href=../org/pytorch/executorch/Module.html>Module</a>
 
@@ -250,26 +276,26 @@ <h2 class="title">L</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/Module.html#load(String)">load(String)</a>
+                    <a href="../org/pytorch/executorch/Module.html#load(String,int,int)">load(String,int,int)</a>
 
                 </span> - function in org.pytorch.executorch.<a href=../org/pytorch/executorch/Module.html>Module</a>
 
 
             </dt>
-            <dd>Loads a serialized ExecuTorch module from the specified path on the disk to run on CPU.</dd>
+            <dd>Loads a serialized ExecuTorch module from the specified path on the disk.</dd>
 
 
             <dt>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#load()">load()</a>
+                    <a href="../org/pytorch/executorch/Module.html#load(String)">load(String)</a>
 
-                </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModule.html>LlmModule</a>
+                </span> - function in org.pytorch.executorch.<a href=../org/pytorch/executorch/Module.html>Module</a>
 
 
             </dt>
-            <dd>Force loading the module.</dd>
+            <dd>Loads a serialized ExecuTorch module from the specified path on the disk to run on CPU.</dd>
 
 
             <dt>
@@ -311,6 +337,19 @@ <h2 class="title">L</h2>
             <dd>Force loading the module.</dd>
 
 
+            <dt>
+                
+                <span class="memberNameLink">
+                
+                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#load()">load()</a>
+                
+                </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModule.html>LlmModule</a>
+                
+
+            </dt>
+            <dd>Force loading the module.</dd>
+
+        
             <dt>
 
                 <span class="memberNameLink">
@@ -328,7 +367,7 @@ <h2 class="title">L</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmModuleConfig.Builder.html#loadMode(int)">loadMode(int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmModuleConfig.Builder.html#loadMode(Integer)">loadMode(Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModuleConfig.Builder.html>LlmModuleConfig.Builder</a>
 

main/javadoc/index-files/index-11.html

@@ -172,7 +172,7 @@ <h2 class="title">M</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmGenerationConfig.Builder.html#maxNewTokens(int)">maxNewTokens(int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmGenerationConfig.Builder.html#maxNewTokens(Integer)">maxNewTokens(Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmGenerationConfig.Builder.html>LlmGenerationConfig.Builder</a>
 
@@ -198,7 +198,7 @@ <h2 class="title">M</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmModuleConfig.Builder.html#modelType(int)">modelType(int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmModuleConfig.Builder.html#modelType(Integer)">modelType(Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModuleConfig.Builder.html>LlmModuleConfig.Builder</a>
 

main/javadoc/index-files/index-12.html

@@ -172,7 +172,7 @@ <h2 class="title">N</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmGenerationConfig.Builder.html#numBos(int)">numBos(int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmGenerationConfig.Builder.html#numBos(Integer)">numBos(Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmGenerationConfig.Builder.html>LlmGenerationConfig.Builder</a>
 
@@ -185,7 +185,7 @@ <h2 class="title">N</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmModuleConfig.Builder.html#numBos(int)">numBos(int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmModuleConfig.Builder.html#numBos(Integer)">numBos(Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModuleConfig.Builder.html>LlmModuleConfig.Builder</a>
 
@@ -224,7 +224,7 @@ <h2 class="title">N</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmGenerationConfig.Builder.html#numEos(int)">numEos(int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmGenerationConfig.Builder.html#numEos(Integer)">numEos(Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmGenerationConfig.Builder.html>LlmGenerationConfig.Builder</a>
 
@@ -237,7 +237,7 @@ <h2 class="title">N</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmModuleConfig.Builder.html#numEos(int)">numEos(int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmModuleConfig.Builder.html#numEos(Integer)">numEos(Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModuleConfig.Builder.html>LlmModuleConfig.Builder</a>
 

main/javadoc/index-files/index-13.html

@@ -146,26 +146,26 @@ <h2 class="title">O</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmCallback.html#onError(int,String)">onError(int,String)</a>
+                    <a href="../org/pytorch/executorch/extension/asr/AsrCallback.html#onError(Integer,String)">onError(Integer,String)</a>
 
-                </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmCallback.html>LlmCallback</a>
+                </span> - function in org.pytorch.executorch.extension.asr.<a href=../org/pytorch/executorch/extension/asr/AsrCallback.html>AsrCallback</a>
 
 
             </dt>
-            <dd>Called when an error occurs during generate().</dd>
+            <dd>Called when an error occurs during transcription.</dd>
 
 
             <dt>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/asr/AsrCallback.html#onError(Integer,String)">onError(Integer,String)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmCallback.html#onError(Integer,String)">onError(Integer,String)</a>
 
-                </span> - function in org.pytorch.executorch.extension.asr.<a href=../org/pytorch/executorch/extension/asr/AsrCallback.html>AsrCallback</a>
+                </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmCallback.html>LlmCallback</a>
 
 
             </dt>
-            <dd>Called when an error occurs during transcription.</dd>
+            <dd>Called when an error occurs during generate().</dd>
 
 
             <dt>

main/javadoc/index-files/index-14.html

@@ -146,7 +146,7 @@ <h2 class="title">P</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#prefillAudio(Array,int,int,int)">prefillAudio(Array,int,int,int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#prefillAudio(ByteArray,Integer,Integer,Integer)">prefillAudio(ByteArray,Integer,Integer,Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModule.html>LlmModule</a>
 
@@ -159,7 +159,7 @@ <h2 class="title">P</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#prefillAudio(Array,int,int,int)">prefillAudio(Array,int,int,int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#prefillAudio(FloatArray,Integer,Integer,Integer)">prefillAudio(FloatArray,Integer,Integer,Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModule.html>LlmModule</a>
 
@@ -172,7 +172,7 @@ <h2 class="title">P</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#prefillImages(Array,int,int,int)">prefillImages(Array,int,int,int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#prefillImages(IntArray,Integer,Integer,Integer)">prefillImages(IntArray,Integer,Integer,Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModule.html>LlmModule</a>
 
@@ -185,7 +185,7 @@ <h2 class="title">P</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#prefillImages(ByteBuffer,int,int,int)">prefillImages(ByteBuffer,int,int,int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#prefillImages(ByteBuffer,Integer,Integer,Integer)">prefillImages(ByteBuffer,Integer,Integer,Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModule.html>LlmModule</a>
 
@@ -198,7 +198,7 @@ <h2 class="title">P</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#prefillImages(Array,int,int,int)">prefillImages(Array,int,int,int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#prefillImages(FloatArray,Integer,Integer,Integer)">prefillImages(FloatArray,Integer,Integer,Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModule.html>LlmModule</a>
 
@@ -211,7 +211,7 @@ <h2 class="title">P</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#prefillNormalizedImage(ByteBuffer,int,int,int)">prefillNormalizedImage(ByteBuffer,int,int,int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#prefillNormalizedImage(ByteBuffer,Integer,Integer,Integer)">prefillNormalizedImage(ByteBuffer,Integer,Integer,Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModule.html>LlmModule</a>
 
@@ -237,7 +237,7 @@ <h2 class="title">P</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#prefillRawAudio(Array,int,int,int)">prefillRawAudio(Array,int,int,int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmModule.html#prefillRawAudio(ByteArray,Integer,Integer,Integer)">prefillRawAudio(ByteArray,Integer,Integer,Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmModule.html>LlmModule</a>
 

main/javadoc/index-files/index-17.html

@@ -146,7 +146,7 @@ <h2 class="title">S</h2>
 
                 <span class="memberNameLink">
 
-                    <a href="../org/pytorch/executorch/extension/llm/LlmGenerationConfig.Builder.html#seqLen(int)">seqLen(int)</a>
+                    <a href="../org/pytorch/executorch/extension/llm/LlmGenerationConfig.Builder.html#seqLen(Integer)">seqLen(Integer)</a>
 
                 </span> - function in org.pytorch.executorch.extension.llm.<a href=../org/pytorch/executorch/extension/llm/LlmGenerationConfig.Builder.html>LlmGenerationConfig.Builder</a>