From 9224d2da06f49b61a64667357816567de6be6540 Mon Sep 17 00:00:00 2001 From: Amith Koujalgi Date: Thu, 22 Feb 2024 11:50:41 +0530 Subject: [PATCH 1/5] Updated base route of docs --- docs/docs/apis-generate/generate.md | 15 ++++++++------- docs/docusaurus.config.js | 2 ++ 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/docs/apis-generate/generate.md b/docs/docs/apis-generate/generate.md index 6d1cf66..aed106e 100644 --- a/docs/docs/apis-generate/generate.md +++ b/docs/docs/apis-generate/generate.md @@ -11,7 +11,7 @@ the [completion](https://github.com/jmorganca/ollama/blob/main/docs/api.md#gener Use the `OptionBuilder` to build the `Options` object with [extra parameters](https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md#valid-parameters-and-values). Refer -to [this](/docs/apis-extras/options-builder). +to [this](/apis-extras/options-builder). ## Try asking a question about the model. @@ -53,25 +53,26 @@ public class Main { OllamaAPI ollamaAPI = new OllamaAPI(host); // define a stream handler (Consumer) OllamaStreamHandler streamHandler = (s) -> { - System.out.println(s); + System.out.println(s); }; // Should be called using seperate thread to gain non blocking streaming effect. OllamaResult result = ollamaAPI.generate(config.getModel(), - "What is the capital of France? And what's France's connection with Mona Lisa?", - new OptionsBuilder().build(), streamHandler); - - System.out.println("Full response: " +result.getResponse()); + "What is the capital of France? And what's France's connection with Mona Lisa?", + new OptionsBuilder().build(), streamHandler); + + System.out.println("Full response: " + result.getResponse()); } } ``` + You will get a response similar to: > The > The capital > The capital of > The capital of France -> The capital of France is +> The capital of France is > The capital of France is Paris > The capital of France is Paris. > Full response: The capital of France is Paris. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index eac9357..cc19285 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -40,6 +40,8 @@ const config = { /** @type {import('@docusaurus/preset-classic').Options} */ ({ docs: { + path: 'docs', + routeBasePath: '', // change this to any URL route you'd want. For example: `home` - if you want /home/intro. sidebarPath: './sidebars.js', // Please change this to your repo. // Remove this to remove the "edit this page" links. From c528fef5fcc2d66223bc6e95dfbd4839e5afaaf5 Mon Sep 17 00:00:00 2001 From: Amith Koujalgi Date: Sat, 13 Jul 2024 17:38:03 +0530 Subject: [PATCH 2/5] Updated GH action to publish maven pkg Signed-off-by: Amith Koujalgi --- .github/workflows/maven-publish.yml | 109 ++++++++++---------------- .github/workflows/publish-javadoc.yml | 52 ------------ maven-publish.yml | 68 ++++++++++++++++ pom.xml | 5 +- 4 files changed, 112 insertions(+), 122 deletions(-) delete mode 100644 .github/workflows/publish-javadoc.yml create mode 100644 maven-publish.yml diff --git a/.github/workflows/maven-publish.yml b/.github/workflows/maven-publish.yml index 430c375..9ecfc2d 100644 --- a/.github/workflows/maven-publish.yml +++ b/.github/workflows/maven-publish.yml @@ -1,68 +1,41 @@ -## This workflow will build a package using Maven and then publish it to GitHub packages when a release is created -## For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#apache-maven-with-a-settings-path -# -#name: Test and Publish Package -# -##on: -## release: -## types: [ "created" ] -# -#on: -# push: -# branches: [ "main" ] -# workflow_dispatch: -# -#jobs: -# build: -# runs-on: ubuntu-latest -# permissions: -# contents: write -# packages: write -# steps: -# - uses: actions/checkout@v3 -# - name: Set up JDK 11 -# uses: actions/setup-java@v3 -# with: -# java-version: '11' -# distribution: 'adopt-hotspot' -# server-id: github # Value of the distributionManagement/repository/id field of the pom.xml -# settings-path: ${{ github.workspace }} # location for the settings.xml file -# - name: Build with Maven -# run: mvn --file pom.xml -U clean package -Punit-tests -# - name: Set up Apache Maven Central (Overwrite settings.xml) -# uses: actions/setup-java@v3 -# with: # running setup-java again overwrites the settings.xml -# java-version: '11' -# distribution: 'adopt-hotspot' -# cache: 'maven' -# server-id: ossrh -# server-username: MAVEN_USERNAME -# server-password: MAVEN_PASSWORD -# gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }} -# gpg-passphrase: MAVEN_GPG_PASSPHRASE -# - name: Set up Maven cache -# uses: actions/cache@v3 -# with: -# path: ~/.m2/repository -# key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} -# restore-keys: | -# ${{ runner.os }}-maven- -# - name: Build -# run: mvn -B -ntp clean install -# - name: Upload coverage reports to Codecov -# uses: codecov/codecov-action@v3 -# env: -# CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} -# - name: Publish to GitHub Packages Apache Maven -# # if: > -# # github.event_name != 'pull_request' && -# # github.ref_name == 'main' && -# # contains(github.event.head_commit.message, 'release') -# run: | -# git config --global user.email "koujalgi.amith@gmail.com" -# git config --global user.name "amithkoujalgi" -# mvn -B -ntp -DskipTests -Pci-cd -Darguments="-DskipTests -Pci-cd" release:clean release:prepare release:perform -# env: -# MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }} -# MAVEN_PASSWORD: ${{ secrets.OSSRH_PASSWORD }} -# MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }} \ No newline at end of file +# This workflow will build a package using Maven and then publish it to GitHub packages when a release is created +# For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#apache-maven-with-a-settings-path + +name: Release Artifacts + +on: + release: + types: [ created ] + +jobs: + build: + + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + + steps: + - uses: actions/checkout@v3 + - name: Set up JDK 17 + uses: actions/setup-java@v3 + with: + java-version: '17' + distribution: 'temurin' + server-id: github # Value of the distributionManagement/repository/id field of the pom.xml + settings-path: ${{ github.workspace }} # location for the settings.xml file + + - name: Find and Replace + uses: jacobtomlinson/gha-find-replace@v3 + with: + find: "ollama4j-revision" + replace: ${{ github.ref_name }} + regex: false + + - name: Build with Maven + run: mvn -B package --file pom.xml + + - name: Publish to GitHub Packages Apache Maven + run: mvn deploy -s $GITHUB_WORKSPACE/settings.xml --file pom.xml + env: + GITHUB_TOKEN: ${{ github.token }} \ No newline at end of file diff --git a/.github/workflows/publish-javadoc.yml b/.github/workflows/publish-javadoc.yml deleted file mode 100644 index 2eba051..0000000 --- a/.github/workflows/publish-javadoc.yml +++ /dev/null @@ -1,52 +0,0 @@ -## Simple workflow for deploying static content to GitHub Pages -#name: Deploy Javadoc content to Pages -# -#on: -# # Runs on pushes targeting the default branch -# push: -# branches: [ "none" ] -# -# # Allows you to run this workflow manually from the Actions tab -# workflow_dispatch: -# -## Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages -#permissions: -# contents: read -# pages: write -# id-token: write -# packages: write -## Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. -## However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. -#concurrency: -# group: "pages" -# cancel-in-progress: false -# -#jobs: -# # Single deploy job since we're just deploying -# deploy: -# runs-on: ubuntu-latest -# -# environment: -# name: github-pages -# url: ${{ steps.deployment.outputs.page_url }} -# steps: -# - uses: actions/checkout@v3 -# - name: Set up JDK 11 -# uses: actions/setup-java@v3 -# with: -# java-version: '11' -# distribution: 'adopt-hotspot' -# server-id: github # Value of the distributionManagement/repository/id field of the pom.xml -# settings-path: ${{ github.workspace }} # location for the settings.xml file -# - name: Build with Maven -# run: mvn --file pom.xml -U clean package -# - name: Setup Pages -# uses: actions/configure-pages@v3 -# - name: Upload artifact -# uses: actions/upload-pages-artifact@v2 -# with: -# # Upload entire repository -# path: './target/apidocs/.' -# - name: Deploy to GitHub Pages -# id: deployment -# uses: actions/deploy-pages@v2 diff --git a/maven-publish.yml b/maven-publish.yml new file mode 100644 index 0000000..430c375 --- /dev/null +++ b/maven-publish.yml @@ -0,0 +1,68 @@ +## This workflow will build a package using Maven and then publish it to GitHub packages when a release is created +## For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#apache-maven-with-a-settings-path +# +#name: Test and Publish Package +# +##on: +## release: +## types: [ "created" ] +# +#on: +# push: +# branches: [ "main" ] +# workflow_dispatch: +# +#jobs: +# build: +# runs-on: ubuntu-latest +# permissions: +# contents: write +# packages: write +# steps: +# - uses: actions/checkout@v3 +# - name: Set up JDK 11 +# uses: actions/setup-java@v3 +# with: +# java-version: '11' +# distribution: 'adopt-hotspot' +# server-id: github # Value of the distributionManagement/repository/id field of the pom.xml +# settings-path: ${{ github.workspace }} # location for the settings.xml file +# - name: Build with Maven +# run: mvn --file pom.xml -U clean package -Punit-tests +# - name: Set up Apache Maven Central (Overwrite settings.xml) +# uses: actions/setup-java@v3 +# with: # running setup-java again overwrites the settings.xml +# java-version: '11' +# distribution: 'adopt-hotspot' +# cache: 'maven' +# server-id: ossrh +# server-username: MAVEN_USERNAME +# server-password: MAVEN_PASSWORD +# gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }} +# gpg-passphrase: MAVEN_GPG_PASSPHRASE +# - name: Set up Maven cache +# uses: actions/cache@v3 +# with: +# path: ~/.m2/repository +# key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} +# restore-keys: | +# ${{ runner.os }}-maven- +# - name: Build +# run: mvn -B -ntp clean install +# - name: Upload coverage reports to Codecov +# uses: codecov/codecov-action@v3 +# env: +# CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} +# - name: Publish to GitHub Packages Apache Maven +# # if: > +# # github.event_name != 'pull_request' && +# # github.ref_name == 'main' && +# # contains(github.event.head_commit.message, 'release') +# run: | +# git config --global user.email "koujalgi.amith@gmail.com" +# git config --global user.name "amithkoujalgi" +# mvn -B -ntp -DskipTests -Pci-cd -Darguments="-DskipTests -Pci-cd" release:clean release:prepare release:perform +# env: +# MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }} +# MAVEN_PASSWORD: ${{ secrets.OSSRH_PASSWORD }} +# MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }} \ No newline at end of file diff --git a/pom.xml b/pom.xml index 2892ed2..fa66d1c 100644 --- a/pom.xml +++ b/pom.xml @@ -1,10 +1,11 @@ - + 4.0.0 io.github.amithkoujalgi ollama4j - 1.0.78-SNAPSHOT + ollama4j-revision Ollama4j Java library for interacting with Ollama API. From ecc295f484be6d3ac691099319d763c095e1905c Mon Sep 17 00:00:00 2001 From: Amith Koujalgi Date: Sat, 13 Jul 2024 17:46:09 +0530 Subject: [PATCH 3/5] Updated GH action to publish maven pkg Signed-off-by: Amith Koujalgi --- .github/workflows/maven-publish.yml | 2 +- pom.xml | 105 +++++++++++++++------------- 2 files changed, 58 insertions(+), 49 deletions(-) diff --git a/.github/workflows/maven-publish.yml b/.github/workflows/maven-publish.yml index 9ecfc2d..7b2466a 100644 --- a/.github/workflows/maven-publish.yml +++ b/.github/workflows/maven-publish.yml @@ -33,7 +33,7 @@ jobs: regex: false - name: Build with Maven - run: mvn -B package --file pom.xml + run: mvn --file pom.xml -U clean package -Punit-tests - name: Publish to GitHub Packages Apache Maven run: mvn deploy -s $GITHUB_WORKSPACE/settings.xml --file pom.xml diff --git a/pom.xml b/pom.xml index fa66d1c..6fd4d9e 100644 --- a/pom.xml +++ b/pom.xml @@ -10,6 +10,7 @@ Ollama4j Java library for interacting with Ollama API. https://github.com/amithkoujalgi/ollama4j + jar 11 @@ -128,15 +129,15 @@ - - org.apache.maven.plugins - maven-release-plugin - 3.0.1 - - - v@{project.version} - - + + + + + + + + + @@ -188,14 +189,22 @@ + + + + + + + + + + + - - ossrh - https://s01.oss.sonatype.org/content/repositories/snapshots - - ossrh - https://s01.oss.sonatype.org/service/local/staging/deploy/maven2 + github + GitHub Packages + https://maven.pkg.github.com/amithkoujalgi/NetWatch @@ -251,39 +260,39 @@ - - org.apache.maven.plugins - maven-gpg-plugin - 3.1.0 - - - sign-artifacts - verify - - sign - - - - - --pinentry-mode - loopback - - - - - - - org.sonatype.plugins - nexus-staging-maven-plugin - 1.6.13 - true - - ossrh - https://s01.oss.sonatype.org/ - true - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + org.jacoco From ee21f7fdd8184de9ca3e0e7e69e63fe768746cf4 Mon Sep 17 00:00:00 2001 From: Amith Koujalgi Date: Sat, 13 Jul 2024 17:55:25 +0530 Subject: [PATCH 4/5] Updated GH action to publish maven pkg Signed-off-by: Amith Koujalgi --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 6fd4d9e..e3cda09 100644 --- a/pom.xml +++ b/pom.xml @@ -204,7 +204,7 @@ github GitHub Packages - https://maven.pkg.github.com/amithkoujalgi/NetWatch + https://maven.pkg.github.com/amithkoujalgi/ollama4j From 9e6503d84b5631897f306567de8aecb400281e54 Mon Sep 17 00:00:00 2001 From: Amith Koujalgi Date: Sat, 13 Jul 2024 18:01:53 +0530 Subject: [PATCH 5/5] clean up Signed-off-by: Amith Koujalgi --- pom.xml | 1 + 1 file changed, 1 insertion(+) diff --git a/pom.xml b/pom.xml index e3cda09..fdaab96 100644 --- a/pom.xml +++ b/pom.xml @@ -200,6 +200,7 @@ + github