Skip to content

Commit

Permalink
models complete
Browse files Browse the repository at this point in the history
  • Loading branch information
tbazant committed Oct 25, 2024
1 parent e30b9b8 commit e4e44ff
Show file tree
Hide file tree
Showing 7 changed files with 415 additions and 3 deletions.
42 changes: 39 additions & 3 deletions articles/openwebui.asm.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@
<!-- R E S O U R C E S -->
<!-- Glue files -->
<resources>
<resource href="../tasks/openwebui-AI-models-exporting-all.xml" xml:id="_openwebui-ai-models-exporting-all"/>
<resource href="../tasks/openwebui-AI-models-exporting.xml" xml:id="_openwebui-ai-models-exporting"/>
<resource href="../tasks/openwebui-AI-models-importing.xml" xml:id="_openwebui-ai-models-importing"/>
<resource href="../tasks/openwebui-AI-models-cloning.xml" xml:id="_openwebui-ai-models-cloning"/>
<resource href="../tasks/openwebui-AI-models-modifying.xml" xml:id="_openwebui-ai-models-modifying"/>
<resource href="../tasks/openwebui-AI-models-deleting.xml" xml:id="_openwebui-ai-models-deleting"/>
<resource href="../tasks/openwebui-AI-models-creating.xml" xml:id="_openwebui-ai-models-creating"/>
<resource href="../tasks/openwebui-setting-chat-model.xml" xml:id="_openwebui-setting-chat-model"/>
<resource href="../tasks/openwebui-setting-user-model.xml" xml:id="_openwebui-setting-user-model"/>
Expand Down Expand Up @@ -299,7 +305,7 @@
</variablelist>
</abstract>
</merge>
<module renderas="section">
<module renderas="section" xml:id="openwebui-setting-default-prompt">
<merge>
<title>Setting the default system prompt</title>
<abstract>
Expand Down Expand Up @@ -329,7 +335,7 @@
</merge>
</module>
</module>
<module renderas="section">
<module renderas="section" xml:id="openwebui-setting-default-models">
<merge>
<title>Setting the default AI model</title>
<abstract>
Expand Down Expand Up @@ -359,7 +365,7 @@
<abstract>
<para>
In &openwebui;, you can create custom AI models based existing
models. Later on, you can modify its features, or share, clone or
models. Later on, you can modify its settings, or share, clone or
delete it.
</para>
</abstract>
Expand All @@ -369,6 +375,36 @@
<title>Creating custom models</title>
</merge>
</module>
<module resourceref="_openwebui-ai-models-modifying" renderas="section">
<merge>
<title>Modifying existing models</title>
</merge>
</module>
<module resourceref="_openwebui-ai-models-cloning" renderas="section">
<merge>
<title>Cloning existing models</title>
</merge>
</module>
<module resourceref="_openwebui-ai-models-importing" renderas="section">
<merge>
<title>Importing exported models</title>
</merge>
</module>
<module resourceref="_openwebui-ai-models-exporting" renderas="section">
<merge>
<title>Exporting existing models</title>
</merge>
</module>
<module resourceref="_openwebui-ai-models-exporting-all" renderas="section">
<merge>
<title>Exporting all existing models</title>
</merge>
</module>
<module resourceref="_openwebui-ai-models-deleting" renderas="section">
<merge>
<title>Deleting existing models</title>
</merge>
</module>
</module>
<module resourceref="_legal"/>
<module resourceref="_ai-glossary" renderas="glossary"/>
Expand Down
66 changes: 66 additions & 0 deletions tasks/openwebui-AI-models-cloning.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
<!-- This file can be edited downstream. -->
<!DOCTYPE topic
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
<!-- point back to this document with a similar comment added to your legacy doc piece -->
<!-- refer to README.md for file and id naming conventions -->
<!-- metadata is dealt with on the assembly level -->
<topic xml:id="openwebui-AI-models-cloning"
role="task" xml:lang="en"
xmlns="http://docbook.org/ns/docbook" version="5.2"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion">
<info>
<title>Cloning existing AI models</title>
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<abstract>
<!-- <xi:include href="../snippets/openwebui-intro.xml"/> -->
<para>
This topic explains how to clone an existing custom AI model using
&openwebui;.
</para>
</abstract>
</info>
<para>
Using the &openwebui; interface, you can clone previously created AI models.
</para>
<procedure>
<itemizedlist>
<title>Requirements</title>
<xi:include href="../snippets/openwebui-requirement-admin-privileges.xml"/>
</itemizedlist>
<step>
<para>
In the &openwebui; interface, click <guimenu>Workspace</guimenu> at the
top of the left panel and select <guimenu>Models</guimenu>.
</para>
</step>
<step>
<para>
In the list of AI models, hover the mouse over the model that you want
to delete and click the three dots on its right.
</para>
</step>
<step>
<para>
From the contextual menu, select <guimenu>Clone</guimenu> to open the
same form as described in <xref linkend="openwebui-AI-models-creating"/>
with all settings copied from the original model. The
<guimenu>Name</guimenu> field has <literal>(Clone)</literal> appended.
</para>
</step>
<step>
<para>
Review the settings and create the cloned AI model with <guimenu>Save
&amp; Create</guimenu>.
</para>
</step>
</procedure>
</topic>
59 changes: 59 additions & 0 deletions tasks/openwebui-AI-models-deleting.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
<!-- This file can be edited downstream. -->
<!DOCTYPE topic
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
<!-- point back to this document with a similar comment added to your legacy doc piece -->
<!-- refer to README.md for file and id naming conventions -->
<!-- metadata is dealt with on the assembly level -->
<topic xml:id="openwebui-AI-models-delete"
role="task" xml:lang="en"
xmlns="http://docbook.org/ns/docbook" version="5.2"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion">
<info>
<title>Deleting existing AI models</title>
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<abstract>
<!-- <xi:include href="../snippets/openwebui-intro.xml"/> -->
<para>
This topic explains how to delete an existing custom AI model using
&openwebui;.
</para>
</abstract>
</info>
<para>
Using the &openwebui; interface, you can delete previously created AI
models.
</para>
<procedure>
<itemizedlist>
<title>Requirements</title>
<xi:include href="../snippets/openwebui-requirement-admin-privileges.xml"/>
</itemizedlist>
<step>
<para>
In the &openwebui; interface, click <guimenu>Workspace</guimenu> at the
top of the left panel and select <guimenu>Models</guimenu>.
</para>
</step>
<step>
<para>
In the list of AI models, hover the mouse over the model that you want
to delete and click the three dots on its right.
</para>
</step>
<step>
<para>
From the contextual menu, select <guimenu>Delete</guimenu> and then
apply with <guimenu>Confirm</guimenu>.
</para>
</step>
</procedure>
</topic>
59 changes: 59 additions & 0 deletions tasks/openwebui-AI-models-exporting-all.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
<!-- This file can be edited downstream. -->
<!DOCTYPE topic
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
<!-- point back to this document with a similar comment added to your legacy doc piece -->
<!-- refer to README.md for file and id naming conventions -->
<!-- metadata is dealt with on the assembly level -->
<topic xml:id="openwebui-AI-models-exporting-all"
role="task" xml:lang="en"
xmlns="http://docbook.org/ns/docbook" version="5.2"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion">
<info>
<title>Exporting all existing AI models</title>
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<abstract>
<!-- <xi:include href="../snippets/openwebui-intro.xml"/> -->
<para>
This topic explains how to export all existing AI models using
&openwebui;.
</para>
</abstract>
</info>
<para>
Using the &openwebui; interface, you can export all existing AI models as a
JSON array.
</para>
<procedure>
<itemizedlist>
<title>Requirements</title>
<xi:include href="../snippets/openwebui-requirement-admin-privileges.xml"/>
</itemizedlist>
<step>
<para>
In the &openwebui; interface, click <guimenu>Workspace</guimenu> at the
top of the left panel and select <guimenu>Models</guimenu>.
</para>
</step>
<step>
<para>
Click the <guimenu>Export Models</guimenu> button at the bottom of the
screen.
</para>
</step>
<step>
<para>
In the file selector, specify the path where you want to save the
exported JSON file. Confirm with <guimenu>Save</guimenu>.
</para>
</step>
</procedure>
</topic>
64 changes: 64 additions & 0 deletions tasks/openwebui-AI-models-exporting.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
<!-- This file can be edited downstream. -->
<!DOCTYPE topic
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
<!-- point back to this document with a similar comment added to your legacy doc piece -->
<!-- refer to README.md for file and id naming conventions -->
<!-- metadata is dealt with on the assembly level -->
<topic xml:id="openwebui-AI-models-exporting"
role="task" xml:lang="en"
xmlns="http://docbook.org/ns/docbook" version="5.2"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion">
<info>
<title>Exporting existing AI models</title>
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<abstract>
<!-- <xi:include href="../snippets/openwebui-intro.xml"/> -->
<para>
This topic explains how to export an existing custom AI model using
&openwebui;.
</para>
</abstract>
</info>
<para>
Using the &openwebui; interface, you can export previously created AI models
as a JSON array.
</para>
<procedure>
<itemizedlist>
<title>Requirements</title>
<xi:include href="../snippets/openwebui-requirement-admin-privileges.xml"/>
</itemizedlist>
<step>
<para>
In the &openwebui; interface, click <guimenu>Workspace</guimenu> at the
top of the left panel and select <guimenu>Models</guimenu>.
</para>
</step>
<step>
<para>
In the list of AI models, hover the mouse over the model that you want
to delete and click the three dots on its right.
</para>
</step>
<step>
<para>
From the contextual menu, select <guimenu>Export</guimenu>.
</para>
</step>
<step>
<para>
In the file selector, specify the path where you want to save the
exported JSON file. Confirm with <guimenu>Save</guimenu>.
</para>
</step>
</procedure>
</topic>
64 changes: 64 additions & 0 deletions tasks/openwebui-AI-models-importing.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
<!-- This file can be edited downstream. -->
<!DOCTYPE topic
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
<!-- point back to this document with a similar comment added to your legacy doc piece -->
<!-- refer to README.md for file and id naming conventions -->
<!-- metadata is dealt with on the assembly level -->
<topic xml:id="openwebui-AI-models-importing"
role="task" xml:lang="en"
xmlns="http://docbook.org/ns/docbook" version="5.2"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion">
<info>
<title>Importing AI models</title>
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<abstract>
<!-- <xi:include href="../snippets/openwebui-intro.xml"/> -->
<para>
This topic explains how to import AI models using &openwebui;.
</para>
</abstract>
</info>
<para>
Using the &openwebui; interface, you can import AI models that were
previously exported as a JSON array.
</para>
<procedure>
<itemizedlist>
<title>Requirements</title>
<xi:include href="../snippets/openwebui-requirement-admin-privileges.xml"/>
</itemizedlist>
<step>
<para>
In the &openwebui; interface, click <guimenu>Workspace</guimenu> at the
top of the left panel and select <guimenu>Models</guimenu>.
</para>
</step>
<step>
<para>
Click the <guimenu>Import Models</guimenu> button at the bottom of the
screen.
</para>
</step>
<step>
<para>
In the file selector, specify the path to the JSON file with the
exported models' definitions. Confirm with <guimenu>Open</guimenu>.
</para>
<important>
<title>Models with identical IDs</title>
<para>
AI models with IDs identical to existing models will not be imported.
</para>
</important>
</step>
</procedure>
</topic>
Loading

0 comments on commit e4e44ff

Please sign in to comment.