Mercurial Repositories > ollama Interface / file comparison
comparison: OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.RunOllamaServerDialog.html
OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.RunOllamaServerDialog.html
- changeset 18
- 0a5b9c233a6e
equal
deleted
inserted
replaced
| 17:43b1396fe72f | 18:0a5b9c233a6e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_AI_Ollama.OllamaInterface.RunOllamaServerDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>Plugin_AI_Ollama.OllamaInterface.RunOllamaServerDialog</h1> | |
| 10 <p> | |
| 11 Module implementing a dialog to run the ollama server locally. | |
| 12 </p> | |
| 13 | |
| 14 <h3>Global Attributes</h3> | |
| 15 <table> | |
| 16 <tr><td>None</td></tr> | |
| 17 </table> | |
| 18 | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#RunOllamaServerDialog">RunOllamaServerDialog</a></td> | |
| 23 <td>Class implementing a dialog to run the ollama server locally.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 | |
| 27 <h3>Functions</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 | |
| 32 <hr /> | |
| 33 <hr /> | |
| 34 <a NAME="RunOllamaServerDialog" ID="RunOllamaServerDialog"></a> | |
| 35 <h2>RunOllamaServerDialog</h2> | |
| 36 <p> | |
| 37 Class implementing a dialog to run the ollama server locally. | |
| 38 </p> | |
| 39 | |
| 40 <h3>Signals</h3> | |
| 41 <dl> | |
| 42 | |
| 43 <dt>serverStarted()</dt> | |
| 44 <dd> | |
| 45 emitted after the start of the 'ollama' server | |
| 46 </dd> | |
| 47 <dt>serverStopped()</dt> | |
| 48 <dd> | |
| 49 emitted after the 'ollama' server was stopped | |
| 50 </dd> | |
| 51 </dl> | |
| 52 <h3>Derived from</h3> | |
| 53 QDialog, Ui_RunOllamaServerDialog | |
| 54 <h3>Class Attributes</h3> | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 | |
| 59 <h3>Class Methods</h3> | |
| 60 <table> | |
| 61 <tr><td>None</td></tr> | |
| 62 </table> | |
| 63 | |
| 64 <h3>Methods</h3> | |
| 65 <table> | |
| 66 <tr> | |
| 67 <td><a href="#RunOllamaServerDialog.__init__">RunOllamaServerDialog</a></td> | |
| 68 <td>Constructor</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#RunOllamaServerDialog.__processFinished">__processFinished</a></td> | |
| 72 <td>Private slot handling the finishing of the server process.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#RunOllamaServerDialog.__readStdOut">__readStdOut</a></td> | |
| 76 <td>Private slot to add the server process output to the output pane.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#RunOllamaServerDialog.closeEvent">closeEvent</a></td> | |
| 80 <td>Protected method handling a close event.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#RunOllamaServerDialog.on_restartServerButton_clicked">on_restartServerButton_clicked</a></td> | |
| 84 <td>Private slot to re-start the ollama server.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#RunOllamaServerDialog.on_stopServerButton_clicked">on_stopServerButton_clicked</a></td> | |
| 88 <td>Private slot to stop the running server.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#RunOllamaServerDialog.startServer">startServer</a></td> | |
| 92 <td>Public method to start the ollama server process.</td> | |
| 93 </tr> | |
| 94 </table> | |
| 95 | |
| 96 <h3>Static Methods</h3> | |
| 97 <table> | |
| 98 <tr><td>None</td></tr> | |
| 99 </table> | |
| 100 | |
| 101 | |
| 102 <a NAME="RunOllamaServerDialog.__init__" ID="RunOllamaServerDialog.__init__"></a> | |
| 103 <h4>RunOllamaServerDialog (Constructor)</h4> | |
| 104 <b>RunOllamaServerDialog</b>(<i>ollamaClient, plugin, parent=None</i>) | |
| 105 <p> | |
| 106 Constructor | |
| 107 </p> | |
| 108 | |
| 109 <dl> | |
| 110 | |
| 111 <dt><i>ollamaClient</i> (OllamaClient)</dt> | |
| 112 <dd> | |
| 113 reference to the 'ollama' client object | |
| 114 </dd> | |
| 115 <dt><i>plugin</i> (PluginOllamaInterface)</dt> | |
| 116 <dd> | |
| 117 reference to the plug-in object | |
| 118 </dd> | |
| 119 <dt><i>parent</i> (QWidget)</dt> | |
| 120 <dd> | |
| 121 reference to the parent widget | |
| 122 </dd> | |
| 123 </dl> | |
| 124 <a NAME="RunOllamaServerDialog.__processFinished" ID="RunOllamaServerDialog.__processFinished"></a> | |
| 125 <h4>RunOllamaServerDialog.__processFinished</h4> | |
| 126 <b>__processFinished</b>(<i></i>) | |
| 127 <p> | |
| 128 Private slot handling the finishing of the server process. | |
| 129 </p> | |
| 130 | |
| 131 <a NAME="RunOllamaServerDialog.__readStdOut" ID="RunOllamaServerDialog.__readStdOut"></a> | |
| 132 <h4>RunOllamaServerDialog.__readStdOut</h4> | |
| 133 <b>__readStdOut</b>(<i></i>) | |
| 134 <p> | |
| 135 Private slot to add the server process output to the output pane. | |
| 136 </p> | |
| 137 | |
| 138 <a NAME="RunOllamaServerDialog.closeEvent" ID="RunOllamaServerDialog.closeEvent"></a> | |
| 139 <h4>RunOllamaServerDialog.closeEvent</h4> | |
| 140 <b>closeEvent</b>(<i>evt</i>) | |
| 141 <p> | |
| 142 Protected method handling a close event. | |
| 143 </p> | |
| 144 | |
| 145 <dl> | |
| 146 | |
| 147 <dt><i>evt</i> (QCloseEvent)</dt> | |
| 148 <dd> | |
| 149 reference to the close event | |
| 150 </dd> | |
| 151 </dl> | |
| 152 <a NAME="RunOllamaServerDialog.on_restartServerButton_clicked" ID="RunOllamaServerDialog.on_restartServerButton_clicked"></a> | |
| 153 <h4>RunOllamaServerDialog.on_restartServerButton_clicked</h4> | |
| 154 <b>on_restartServerButton_clicked</b>(<i></i>) | |
| 155 <p> | |
| 156 Private slot to re-start the ollama server. | |
| 157 </p> | |
| 158 | |
| 159 <a NAME="RunOllamaServerDialog.on_stopServerButton_clicked" ID="RunOllamaServerDialog.on_stopServerButton_clicked"></a> | |
| 160 <h4>RunOllamaServerDialog.on_stopServerButton_clicked</h4> | |
| 161 <b>on_stopServerButton_clicked</b>(<i></i>) | |
| 162 <p> | |
| 163 Private slot to stop the running server. | |
| 164 </p> | |
| 165 | |
| 166 <a NAME="RunOllamaServerDialog.startServer" ID="RunOllamaServerDialog.startServer"></a> | |
| 167 <h4>RunOllamaServerDialog.startServer</h4> | |
| 168 <b>startServer</b>(<i></i>) | |
| 169 <p> | |
| 170 Public method to start the ollama server process. | |
| 171 </p> | |
| 172 | |
| 173 <dl> | |
| 174 <dt>Return:</dt> | |
| 175 <dd> | |
| 176 flag indicating success | |
| 177 </dd> | |
| 178 </dl> | |
| 179 <dl> | |
| 180 <dt>Return Type:</dt> | |
| 181 <dd> | |
| 182 bool | |
| 183 </dd> | |
| 184 </dl> | |
| 185 <div align="right"><a href="#top">Up</a></div> | |
| 186 <hr /> | |
| 187 </body></html> |
