updated docs

This commit is contained in:
Amith Koujalgi
2023-12-26 17:43:18 +05:30
parent a5f986f145
commit 9070597c17
32 changed files with 391 additions and 1045 deletions

View File

@@ -1,34 +1,23 @@
---
sidebar_position: 3
sidebar_position: 4
---
# Create Model
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
This API lets you create a custom model on the Ollama server.
## Create your first Post
```java title="CreateModel.java"
public class CreateModel {
Create a file at `blog/2021-02-28-greetings.md`:
public static void main(String[] args) {
```md title="blog/2021-02-28-greetings.md"
---
slug: greetings
title: Greetings!
authors:
- name: Joel Marcey
title: Co-creator of Docusaurus 1
url: https://github.com/JoelMarcey
image_url: https://github.com/JoelMarcey.png
- name: Sébastien Lorber
title: Docusaurus maintainer
url: https://sebastienlorber.com
image_url: https://github.com/slorber.png
tags: [greetings]
---
String host = "http://localhost:11434/";
Congratulations, you have made your first post!
OllamaAPI ollamaAPI = new OllamaAPI(host);
Feel free to play around and edit this post as much you like.
ollamaAPI.createModel("mycustommodel", "/path/to/modelfile/on/ollama-server");
}
}
```
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
Once created, you can see it when you use [list models](./list-models) API.

View File

@@ -4,28 +4,19 @@ sidebar_position: 5
# Delete Model
Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
This API lets you create a delete a model from the Ollama server.
It builds your site as simple **static HTML, JavaScript and CSS files**.
```java title="DeleteModel.java"
public class Main {
## Build your site
public static void main(String[] args) {
String host = "http://localhost:11434/";
OllamaAPI ollamaAPI = new OllamaAPI(host);
ollamaAPI.setVerbose(false);
ollamaAPI.deleteModel("mycustommodel", true);
}
}
Build your site **for production**:
```bash
npm run build
```
The static files are generated in the `build` folder.
## Deploy your site
Test your production build locally:
```bash
npm run serve
```
The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
Once deleted, you can verify it using [list models](./list-models) API.

View File

@@ -1,57 +0,0 @@
---
sidebar_position: 2
---
# Generate Embeddings
Documents are **groups of pages** connected through:
- a **sidebar**
- **previous/next navigation**
- **versioning**
## Create your first Doc
Create a Markdown file at `docs/hello.md`:
```md title="docs/hello.md"
# Hello
This is my **first Docusaurus document**!
```
A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
## Configure the Sidebar
Docusaurus automatically **creates a sidebar** from the `docs` folder.
Add metadata to customize the sidebar label and position:
```md title="docs/hello.md" {1-4}
---
sidebar_label: 'Hi!'
sidebar_position: 3
---
# Hello
This is my **first Docusaurus document**!
```
It is also possible to create your sidebar explicitly in `sidebars.js`:
```js title="sidebars.js"
export default {
tutorialSidebar: [
'intro',
// highlight-next-line
'hello',
{
type: 'category',
label: 'Tutorial',
items: ['tutorial-basics/create-a-document'],
},
],
};
```

File diff suppressed because one or more lines are too long

View File

@@ -4,40 +4,27 @@ sidebar_position: 1
# List Models
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
This API lets you list available models on the Ollama server.
- `src/pages/index.js``localhost:3000/`
- `src/pages/foo.md``localhost:3000/foo`
- `src/pages/foo/bar.js``localhost:3000/foo/bar`
```java title="ListModels.java"
public class ListModels {
## Create your first React Page
public static void main(String[] args) {
Create a file at `src/pages/my-react-page.js`:
String host = "http://localhost:11434/";
```jsx title="src/pages/my-react-page.js"
import React from 'react';
import Layout from '@theme/Layout';
OllamaAPI ollamaAPI = new OllamaAPI(host);
export default function MyReactPage() {
return (
<Layout>
<h1>My React page</h1>
<p>This is a React page</p>
</Layout>
);
List<Model> models = ollamaAPI.listModels();
models.forEach(model -> System.out.println(model.getName()));
}
}
```
A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).
If you have any models already downloaded on Ollama server, you would have them listed as follows:
## Create your first Markdown Page
Create a file at `src/pages/my-markdown-page.md`:
```mdx title="src/pages/my-markdown-page.md"
# My Markdown page
This is a Markdown page
```
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).
```bash
llama2:latest
sqlcoder:latest
```

View File

@@ -1,23 +1,23 @@
---
sidebar_position: 6
sidebar_position: 2
---
# Pull Model
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
This API lets you pull a model on the Ollama server.
Docusaurus has **much more to offer**!
```java title="PullModel.java"
public class Main {
Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
public static void main(String[] args) {
String host = "http://localhost:11434/";
Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
OllamaAPI ollamaAPI = new OllamaAPI(host);
## What's next?
ollamaAPI.pullModel(OllamaModelType.LLAMA2);
}
}
```
- Read the [official documentation](https://docusaurus.io/)
- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config)
- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration)
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
- Add a [search bar](https://docusaurus.io/docs/search)
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
Once downloaded, you can see them when you use [list models](./list-models) API.