Mercurial Repositories > ollama Interface / file diff

diff: OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.OllamaPullProgressDialog.html

OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.OllamaPullProgressDialog.html

changeset 18
0a5b9c233a6e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.OllamaPullProgressDialog.html	Thu Aug 29 13:15:36 2024 +0200
@@ -0,0 +1,356 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_AI_Ollama.OllamaInterface.OllamaPullProgressDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_AI_Ollama.OllamaInterface.OllamaPullProgressDialog</h1>
+<p>
+Module implementing a dialog showing the progress of a model pull action..
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#OllamaPullProgressBar">OllamaPullProgressBar</a></td>
+<td>Class implementing a progress bar allowing values outside the standard range.</td>
+</tr>
+<tr>
+<td><a href="#OllamaPullProgressDialog">OllamaPullProgressDialog</a></td>
+<td>Class implementing a dialog showing the progress of a model pull action.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="OllamaPullProgressBar" ID="OllamaPullProgressBar"></a>
+<h2>OllamaPullProgressBar</h2>
+<p>
+    Class implementing a progress bar allowing values outside the standard range.
+</p>
+
+<h3>Derived from</h3>
+QProgressBar
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#OllamaPullProgressBar.__init__">OllamaPullProgressBar</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#OllamaPullProgressBar.maximum">maximum</a></td>
+<td>Public method to get the maximum value.</td>
+</tr>
+<tr>
+<td><a href="#OllamaPullProgressBar.setMaximum">setMaximum</a></td>
+<td>Public method to set the maximum value.</td>
+</tr>
+<tr>
+<td><a href="#OllamaPullProgressBar.setValue">setValue</a></td>
+<td>Public method to set the current value.</td>
+</tr>
+<tr>
+<td><a href="#OllamaPullProgressBar.value">value</a></td>
+<td>Public method to get the current value.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="OllamaPullProgressBar.__init__" ID="OllamaPullProgressBar.__init__"></a>
+<h4>OllamaPullProgressBar (Constructor)</h4>
+<b>OllamaPullProgressBar</b>(<i>parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="OllamaPullProgressBar.maximum" ID="OllamaPullProgressBar.maximum"></a>
+<h4>OllamaPullProgressBar.maximum</h4>
+<b>maximum</b>(<i></i>)
+<p>
+        Public method to get the maximum value.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+maximum value
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
+</dl>
+<a NAME="OllamaPullProgressBar.setMaximum" ID="OllamaPullProgressBar.setMaximum"></a>
+<h4>OllamaPullProgressBar.setMaximum</h4>
+<b>setMaximum</b>(<i>value</i>)
+<p>
+        Public method to set the maximum value.
+</p>
+
+<dl>
+
+<dt><i>value</i> (int)</dt>
+<dd>
+new maximum value
+</dd>
+</dl>
+<a NAME="OllamaPullProgressBar.setValue" ID="OllamaPullProgressBar.setValue"></a>
+<h4>OllamaPullProgressBar.setValue</h4>
+<b>setValue</b>(<i>value</i>)
+<p>
+        Public method to set the current value.
+</p>
+
+<dl>
+
+<dt><i>value</i> (int)</dt>
+<dd>
+new value
+</dd>
+</dl>
+<a NAME="OllamaPullProgressBar.value" ID="OllamaPullProgressBar.value"></a>
+<h4>OllamaPullProgressBar.value</h4>
+<b>value</b>(<i></i>)
+<p>
+        Public method to get the current value.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+current value
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="OllamaPullProgressDialog" ID="OllamaPullProgressDialog"></a>
+<h2>OllamaPullProgressDialog</h2>
+<p>
+    Class implementing a dialog showing the progress of a model pull action.
+</p>
+
+<h3>Signals</h3>
+<dl>
+
+<dt>abortPull()</dt>
+<dd>
+emitted to abort the current model pull operation
+</dd>
+</dl>
+<h3>Derived from</h3>
+QDialog, Ui_OllamaPullProgressDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#OllamaPullProgressDialog.__init__">OllamaPullProgressDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#OllamaPullProgressDialog.clear">clear</a></td>
+<td>Public method to clear the progress information.</td>
+</tr>
+<tr>
+<td><a href="#OllamaPullProgressDialog.closeEvent">closeEvent</a></td>
+<td>Protected method to handle a close event.</td>
+</tr>
+<tr>
+<td><a href="#OllamaPullProgressDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot handling a button of the button box being clicked.</td>
+</tr>
+<tr>
+<td><a href="#OllamaPullProgressDialog.setFinished">setFinished</a></td>
+<td>Public method to set the finished state.</td>
+</tr>
+<tr>
+<td><a href="#OllamaPullProgressDialog.setModel">setModel</a></td>
+<td>Public method to show the model name in the header.</td>
+</tr>
+<tr>
+<td><a href="#OllamaPullProgressDialog.setStatus">setStatus</a></td>
+<td>Public method to show the status update.</td>
+</tr>
+<tr>
+<td><a href="#OllamaPullProgressDialog.showError">showError</a></td>
+<td>Public method to show an error message reported by the server.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="OllamaPullProgressDialog.__init__" ID="OllamaPullProgressDialog.__init__"></a>
+<h4>OllamaPullProgressDialog (Constructor)</h4>
+<b>OllamaPullProgressDialog</b>(<i>parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="OllamaPullProgressDialog.clear" ID="OllamaPullProgressDialog.clear"></a>
+<h4>OllamaPullProgressDialog.clear</h4>
+<b>clear</b>(<i></i>)
+<p>
+        Public method to clear the progress information.
+</p>
+
+<a NAME="OllamaPullProgressDialog.closeEvent" ID="OllamaPullProgressDialog.closeEvent"></a>
+<h4>OllamaPullProgressDialog.closeEvent</h4>
+<b>closeEvent</b>(<i>evt</i>)
+<p>
+        Protected method to handle a close event.
+</p>
+
+<dl>
+
+<dt><i>evt</i> (QCloseEvent)</dt>
+<dd>
+reference to the close event object
+</dd>
+</dl>
+<a NAME="OllamaPullProgressDialog.on_buttonBox_clicked" ID="OllamaPullProgressDialog.on_buttonBox_clicked"></a>
+<h4>OllamaPullProgressDialog.on_buttonBox_clicked</h4>
+<b>on_buttonBox_clicked</b>(<i>button</i>)
+<p>
+        Private slot handling a button of the button box being clicked.
+</p>
+
+<dl>
+
+<dt><i>button</i> (QAbstractButton)</dt>
+<dd>
+reference to the clicked button
+</dd>
+</dl>
+<a NAME="OllamaPullProgressDialog.setFinished" ID="OllamaPullProgressDialog.setFinished"></a>
+<h4>OllamaPullProgressDialog.setFinished</h4>
+<b>setFinished</b>(<i>finished</i>)
+<p>
+        Public method to set the finished state.
+</p>
+
+<dl>
+
+<dt><i>finished</i> (bool)</dt>
+<dd>
+flag indicating the finished state
+</dd>
+</dl>
+<a NAME="OllamaPullProgressDialog.setModel" ID="OllamaPullProgressDialog.setModel"></a>
+<h4>OllamaPullProgressDialog.setModel</h4>
+<b>setModel</b>(<i>model</i>)
+<p>
+        Public method to show the model name in the header.
+</p>
+
+<dl>
+
+<dt><i>model</i> (str)</dt>
+<dd>
+model name
+</dd>
+</dl>
+<a NAME="OllamaPullProgressDialog.setStatus" ID="OllamaPullProgressDialog.setStatus"></a>
+<h4>OllamaPullProgressDialog.setStatus</h4>
+<b>setStatus</b>(<i>status, idStr, total, completed</i>)
+<p>
+        Public method to show the status update.
+</p>
+
+<dl>
+
+<dt><i>status</i> (str)</dt>
+<dd>
+status message reported by the 'ollama' server
+</dd>
+<dt><i>idStr</i> (str)</dt>
+<dd>
+ID of the file being pulled or empty
+</dd>
+<dt><i>total</i> (int)</dt>
+<dd>
+size of the file being pulled or 0 in case of an empty ID
+</dd>
+<dt><i>completed</i> (int)</dt>
+<dd>
+downloaded bytes or 0 in case of an empty ID
+</dd>
+</dl>
+<a NAME="OllamaPullProgressDialog.showError" ID="OllamaPullProgressDialog.showError"></a>
+<h4>OllamaPullProgressDialog.showError</h4>
+<b>showError</b>(<i>errMsg</i>)
+<p>
+        Public method to show an error message reported by the server.
+</p>
+
+<dl>
+
+<dt><i>errMsg</i> (str)</dt>
+<dd>
+error message
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

Mercurial Repository: ollama Interface

eric ide

mercurial