Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: sync dev branch to docs branch #2239

Merged
merged 123 commits into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
123 commits
Select commit Hold shift + click to select a range
4e89732
Update quickstart content
aindrajaya Feb 23, 2024
fcb909f
Add plugin to fetch GH releases page recent data
aindrajaya Feb 23, 2024
c4ab52b
Merge pull request #2138 from aindrajaya/docs-pena-team
0xHieu01 Feb 23, 2024
3e0fe74
Merge branch 'dev' into docs-pena-team
0xHieu01 Feb 23, 2024
d7bf98b
adds code samples for list models
avb-is-me Feb 27, 2024
593d9e0
Merge branch 'dev' into dev-docs-list-models-update
avb-is-me Feb 27, 2024
1635717
add docs for the model/model_id endpoints
avb-is-me Feb 27, 2024
e5726b3
Merge branch 'dev' into devdocs_update_to_modelid
avb-is-me Feb 27, 2024
a6dbcf3
adds code snippets for download
avb-is-me Feb 27, 2024
90a11ea
adds code snippets for chat completeions
avb-is-me Feb 27, 2024
b0376ba
Merge branch 'dev' into devdocs_update_download_model
avb-is-me Feb 27, 2024
a971766
Merge branch 'dev' into devdocs_updates_chat_completions
avb-is-me Feb 27, 2024
0dbccbd
docs: add and update the path of Image
aindrajaya Feb 27, 2024
b7248bc
docs: correct content on quickstart & installation
aindrajaya Feb 27, 2024
b4e2ee7
docs: update the models content
aindrajaya Feb 27, 2024
b081a91
docs: update the content of integration & add discord + openinterpreter
aindrajaya Feb 27, 2024
9210d20
docs: update extension content
aindrajaya Feb 27, 2024
94e8b23
docs: add common error content
aindrajaya Feb 27, 2024
701dd30
docs: add error-codes content
aindrajaya Feb 27, 2024
001432d
Merge branch 'dev' into docs-pena-team
0xHieu01 Feb 27, 2024
3c0ef12
Merge branch 'dev' into devdocs_updates_chat_completions
avb-is-me Feb 27, 2024
0309d74
adds code snippets for threads
avb-is-me Feb 27, 2024
3d24af5
docs: fix the customize engine section
aindrajaya Feb 28, 2024
0e52499
docs: remove unecessary code/content
aindrajaya Feb 28, 2024
a535ce8
docs: fix typo and shorten the step title
aindrajaya Feb 28, 2024
3a3622a
docs: fix apiBase value -> http://localhost:1337/v1
aindrajaya Feb 28, 2024
67cfb83
Merge branch 'docs-pena-team' of github.com:janhq/jan into docs-pena-…
aindrajaya Feb 28, 2024
d878c85
fix: error href link
0xHieu01 Feb 28, 2024
22ad9df
Merge branch 'dev' into docs-pena-team
0xHieu01 Feb 28, 2024
e9bd36f
docs: update the content for showing in card
aindrajaya Feb 28, 2024
cf3ac47
docs: implement image in doc card
aindrajaya Feb 28, 2024
4267589
chore: bump nitro 0.3.14 (#2183)
louis-menlo Feb 28, 2024
f10b702
docs: Update 08-antivirus-compatibility-testing.md
freelerobot Feb 28, 2024
499aa4a
docs: Update 01-integrate-continue.mdx
freelerobot Feb 28, 2024
43ae502
janhq/jan: Update README.md with nightly build artifact URL
jan-service-account Feb 28, 2024
c36de31
Merge pull request #2187 from janhq/0xSage-patch-4
0xHieu01 Feb 28, 2024
8b9cd7a
adding new feature for v0.4.7
Van-QA Feb 28, 2024
7e7b88b
docs: update regression test template (#2189)
0xHieu01 Feb 28, 2024
30581ae
docs: Update 08-antivirus-compatibility-testing.md (#2186)
0xHieu01 Feb 28, 2024
a4478b0
Merge branch 'docs-pena-team' of github.com:janhq/jan into docs-pena-…
aindrajaya Feb 28, 2024
08c4540
adds updates to assistant
avb-is-me Feb 28, 2024
11ff9a2
adds code samples for the assistant_id endpoints
avb-is-me Feb 28, 2024
bfd1f08
Merge branch 'dev' into docs_updates_to_assistants
avb-is-me Feb 28, 2024
4288af0
Merge branch 'dev' into docs_updates_to_assistant_id
avb-is-me Feb 28, 2024
faec5cf
Merge branch 'dev' into docs-pena-team
0xHieu01 Feb 29, 2024
44d9f5b
fix: minor ui missing secondary background (#2198)
urmauur Feb 29, 2024
5c185d2
fix: download model error does not reset state in model hub (#2199)
namchuai Feb 29, 2024
1585f3d
docs: update content quickstart integration add mistral ollama & lm
aindrajaya Feb 29, 2024
53f66ce
docs: Update quickstart content add keywords
aindrajaya Feb 29, 2024
d449078
docs: add quickstart assets
aindrajaya Feb 29, 2024
7004a8b
docs: update integration content & add keywords
aindrajaya Feb 29, 2024
e4ff358
docs: update model content and add keywords
aindrajaya Feb 29, 2024
8e12e3a
janhq/jan: Update README.md with nightly build artifact URL
jan-service-account Mar 1, 2024
2dc90f8
docs: add hub page named trial -> /trial
aindrajaya Mar 1, 2024
5e248b7
docs: update and add quickstart content
aindrajaya Mar 1, 2024
66cdd88
docs: add advance settings menu and content
aindrajaya Mar 1, 2024
328bb6b
docs: update common-error section by add keywords for each page
aindrajaya Mar 1, 2024
774db85
docs: update content error-codes section by add keywords and description
aindrajaya Mar 1, 2024
8e77307
docs: update content integration section by add keywords and description
aindrajaya Mar 1, 2024
a906dc1
docs: update extensions section by add keywords and description
aindrajaya Mar 1, 2024
990ae19
docs: update content models section remove image and add keywords
aindrajaya Mar 1, 2024
90fff56
docs: implement icon menu for mistral, lm and ollama
aindrajaya Mar 1, 2024
ef45995
docs: update content for Trial page -> the hub section
aindrajaya Mar 1, 2024
a4aefa8
Merge branch 'dev' into docs-pena-team
0xHieu01 Mar 1, 2024
0985a44
docs: correct advanced settings
0xHieu01 Mar 1, 2024
28ac386
docs: migrate import using absolute filepath content
0xHieu01 Mar 1, 2024
b969346
fix: configure the Algolia search
0xHieu01 Mar 1, 2024
4744d4c
feat: enable contextSearch
0xHieu01 Mar 1, 2024
02de234
feat: connect siteConfig
0xHieu01 Mar 1, 2024
018b057
Merge branch 'dev' into dev-docs-list-models-update
0xHieu01 Mar 2, 2024
764bc2c
docs: update API Reference listModel from DevDocs (#2161)
0xHieu01 Mar 2, 2024
9cd2454
Merge branch 'dev' into devdocs_update_to_modelid
0xHieu01 Mar 2, 2024
69be8d7
docs: update API Reference model_id from DevDocs (#2169)
0xHieu01 Mar 2, 2024
9c5be3b
Merge branch 'dev' into devdocs_update_download_model
0xHieu01 Mar 2, 2024
199c272
docs: update API Reference download model from DevDocs (#2170)
0xHieu01 Mar 2, 2024
2a893b4
Merge branch 'dev' into devdocs_updates_chat_completions
0xHieu01 Mar 2, 2024
d6ccda0
docs: update API Reference chatCompletions from DevDocs (#2171)
0xHieu01 Mar 2, 2024
fabc279
Merge branch 'dev' into docs-pena-team
0xHieu01 Mar 2, 2024
7acc445
Merge branch 'dev' into doc_updates_to_threads_endpoint
0xHieu01 Mar 2, 2024
b03a9b2
docs: update API Reference threads endpoint from DevDocs (#2182)
0xHieu01 Mar 2, 2024
fb51deb
Merge branch 'dev' into docs_updates_to_assistants
0xHieu01 Mar 2, 2024
fde1207
docs: update API Reference assistants endpoint from DevDocs (#2194)
0xHieu01 Mar 2, 2024
5a6c20c
Merge branch 'dev' into docs_updates_to_assistant_id
0xHieu01 Mar 2, 2024
02f2536
docs: re-order language support consistency
0xHieu01 Mar 2, 2024
497020c
docs: yaml lint
0xHieu01 Mar 2, 2024
7f2513f
docs: update API Reference assistants_id endpoint from DevDocs (#2195)
0xHieu01 Mar 2, 2024
52f84dc
chore: clean up some redundant code (#2215)
namchuai Mar 3, 2024
b70e7fb
fix: comment from QA regarding import model (#2213)
namchuai Mar 3, 2024
1bdf791
fix: import from HuggingFace with random string is causing app crash …
louis-menlo Mar 3, 2024
3ca6699
docs: change the hub slug into /docs and the latests /docs into /fram…
aindrajaya Mar 4, 2024
9791da5
docs: removed duplicate guides section
aindrajaya Mar 4, 2024
71f314b
docs: change folder structure from quickstart to guides
aindrajaya Mar 4, 2024
d695f4a
docs: Changelogs plugin updated without accessToken
aindrajaya Mar 4, 2024
6121283
feat: add turborepo (#2220)
louis-menlo Mar 4, 2024
cb3c700
docs: input framework menu into /developer slug
aindrajaya Mar 4, 2024
89133fb
docs: hub page responsive fixed
aindrajaya Mar 4, 2024
544e9fd
docs: fix the redirect paths
aindrajaya Mar 4, 2024
6844bf6
Merge branch 'dev' into docs-pena-team
0xHieu01 Mar 4, 2024
4aa09e0
docs: fix homepage link
aindrajaya Mar 4, 2024
635435f
Revert feat: temporary remove dark mode (#2221)
urmauur Mar 4, 2024
2a3d32c
Merge branch 'dev' into docs-pena-team
0xHieu01 Mar 4, 2024
07ef5b8
docs: 2nd navbar implementation
aindrajaya Mar 4, 2024
fc8eb28
docs: update path from category -> guides
aindrajaya Mar 4, 2024
2fb9931
docs: hub page fix link for the content
aindrajaya Mar 4, 2024
217ae16
docs: update models content import and integrate remote -> model.json…
aindrajaya Mar 4, 2024
1f9418b
docs: add faqs page
aindrajaya Mar 4, 2024
78b6fe3
docs: update content for advanced settings
aindrajaya Mar 4, 2024
00726e7
docs: fix href ink
aindrajaya Mar 4, 2024
435b947
Merge branch 'docs-pena-team' of github.com:janhq/jan into docs-pena-…
aindrajaya Mar 4, 2024
5570091
Macos Notarize migrage to new Team ID (#2228)
hiento09 Mar 4, 2024
5540cd2
Merge branch 'dev' into docs-pena-team
0xHieu01 Mar 4, 2024
c5d7942
janhq/jan: Update README.md with nightly build artifact URL
jan-service-account Mar 4, 2024
7d4acf1
docs: update title Docs | Jan
0xHieu01 Mar 4, 2024
d402570
Merge branch 'dev' into docs-pena-team
0xHieu01 Mar 4, 2024
af1eb80
docs: revamp entire Jan guides (#2139)
0xHieu01 Mar 4, 2024
dcd36eb
fix: re-configure changelog sections
0xHieu01 Mar 4, 2024
32b4162
docs: add command run API server without frontend
0xHieu01 Mar 4, 2024
dca5af8
docs: add command run API server without frontend (#2231)
0xHieu01 Mar 4, 2024
ab78319
fix: re-configure changelog sections (#2230)
0xHieu01 Mar 4, 2024
1584f0d
Add prefix latest/ for task clean r2 bucket (#2233)
hiento09 Mar 4, 2024
e6c1020
feat: Jan can see (#2069)
hiro-v Mar 5, 2024
0201363
fix: drag and drop support image format when model has vision_model a…
urmauur Mar 5, 2024
8ecd936
fix: replaced user path from app log (#2238)
namchuai Mar 5, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ jobs:
- name: Delete object older than 10 days
run: |
# Get the list of objects in the 'latest' folder
OBJECTS=$(aws s3api list-objects --bucket ${{ secrets.CLOUDFLARE_R2_BUCKET_NAME }} --query 'Contents[?LastModified<`'$(date -d "$current_date -10 days" -u +"%Y-%m-%dT%H:%M:%SZ")'`].{Key: Key}' --endpoint-url https://${{ secrets.CLOUDFLARE_ACCOUNT_ID }}.r2.cloudflarestorage.com | jq -c .)
OBJECTS=$(aws s3api list-objects --bucket ${{ secrets.CLOUDFLARE_R2_BUCKET_NAME }} --prefix "latest/" --query 'Contents[?LastModified<`'$(date -d "$current_date -10 days" -u +"%Y-%m-%dT%H:%M:%SZ")'`].{Key: Key}' --endpoint-url https://${{ secrets.CLOUDFLARE_ACCOUNT_ID }}.r2.cloudflarestorage.com | jq -c .)

# Create a JSON file for the delete operation
echo "{\"Objects\": $OBJECTS, \"Quiet\": false}" > delete.json
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,7 @@ extensions/inference-nitro-extension/bin/saved-*
extensions/inference-nitro-extension/bin/*.tar.gz
extensions/inference-nitro-extension/bin/vulkaninfoSDK.exe
extensions/inference-nitro-extension/bin/vulkaninfo


# Turborepo
.turbo
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,31 +76,31 @@ Jan is an open-source ChatGPT alternative that runs 100% offline on your compute
<tr style="text-align:center">
<td style="text-align:center"><b>Experimental (Nightly Build)</b></td>
<td style="text-align:center">
<a href='https://delta.jan.ai/latest/jan-win-x64-0.4.7-290.exe'>
<a href='https://delta.jan.ai/latest/jan-win-x64-0.4.7-295.exe'>
<img src='./docs/static/img/windows.png' style="height:14px; width: 14px" />
<b>jan.exe</b>
</a>
</td>
<td style="text-align:center">
<a href='https://delta.jan.ai/latest/jan-mac-x64-0.4.7-290.dmg'>
<a href='https://delta.jan.ai/latest/jan-mac-x64-0.4.7-295.dmg'>
<img src='./docs/static/img/mac.png' style="height:15px; width: 15px" />
<b>Intel</b>
</a>
</td>
<td style="text-align:center">
<a href='https://delta.jan.ai/latest/jan-mac-arm64-0.4.7-290.dmg'>
<a href='https://delta.jan.ai/latest/jan-mac-arm64-0.4.7-295.dmg'>
<img src='./docs/static/img/mac.png' style="height:15px; width: 15px" />
<b>M1/M2</b>
</a>
</td>
<td style="text-align:center">
<a href='https://delta.jan.ai/latest/jan-linux-amd64-0.4.7-290.deb'>
<a href='https://delta.jan.ai/latest/jan-linux-amd64-0.4.7-295.deb'>
<img src='./docs/static/img/linux.png' style="height:14px; width: 14px" />
<b>jan.deb</b>
</a>
</td>
<td style="text-align:center">
<a href='https://delta.jan.ai/latest/jan-linux-x86_64-0.4.7-290.AppImage'>
<a href='https://delta.jan.ai/latest/jan-linux-x86_64-0.4.7-295.AppImage'>
<img src='./docs/static/img/linux.png' style="height:14px; width: 14px" />
<b>jan.AppImage</b>
</a>
Expand Down Expand Up @@ -209,6 +209,12 @@ Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) fi

This will start the development server and open the desktop app.

3. (Optional) **Run the API server without frontend**

```bash
yarn dev:server
```

### For production build

```bash
Expand Down
18 changes: 18 additions & 0 deletions core/src/node/api/processors/download.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,24 @@ export class Downloader implements Processor {
// Downloading file to a temp file first
const downloadingTempFile = `${destination}.download`

// adding initial download state
const initialDownloadState: DownloadState = {
modelId,
fileName,
time: {
elapsed: 0,
remaining: 0,
},
speed: 0,
percent: 0,
size: {
total: 0,
transferred: 0,
},
downloadState: 'downloading',
}
DownloadManager.instance.downloadProgressMap[modelId] = initialDownloadState

progress(rq, {})
.on('progress', (state: any) => {
const downloadState: DownloadState = {
Expand Down
11 changes: 4 additions & 7 deletions core/src/types/model/modelEntity.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export type ModelInfo = {
settings: ModelSettingParams
parameters: ModelRuntimeParams
engine?: InferenceEngine
proxyEngine?: InferenceEngine
proxy_model?: InferenceEngine
}

/**
Expand Down Expand Up @@ -93,12 +93,7 @@ export type Model = {
*/
engine: InferenceEngine

proxyEngine?: InferenceEngine

/**
* Is multimodal or not.
*/
visionModel?: boolean
proxy_model?: InferenceEngine
}

export type ModelMetadata = {
Expand All @@ -124,6 +119,8 @@ export type ModelSettingParams = {
llama_model_path?: string
mmproj?: string
cont_batching?: boolean
vision_model?: boolean
text_model?: boolean
}

/**
Expand Down
3 changes: 2 additions & 1 deletion docs/.env.example
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ GTM_ID=xxxx
UMAMI_PROJECT_API_KEY=xxxx
UMAMI_APP_URL=xxxx
ALGOLIA_API_KEY=xxxx
ALGOLIA_APP_ID=xxxx
ALGOLIA_APP_ID=xxxx
GITHUB_ACCESS_TOKEN=xxxx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ keywords:

Ensure your system meets the following specifications to guarantee a smooth development experience:

- [Hardware Requirements](../../guides/02-installation/06-hardware.md)
- Hardware Requirements

### System Requirements

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/developer/01-overview/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ keywords:
The following docs are aimed at developers who want to build extensions on top of the Jan Framework.

:::tip
If you are interested to **contribute to the framework's Core SDK itself**, like adding new drivers, runtimes, and infrastructure level support, please refer to [framework docs](/docs) instead.
If you are interested to **contribute to the framework's Core SDK itself**, like adding new drivers, runtimes, and infrastructure level support, please refer to [framework docs](/developer/framework) instead.
:::

## Extensions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Engineering Specs
slug: /docs/engineering
slug: /developer/engineering
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords:
[
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Product Specs
slug: /docs/product
slug: /developer/product
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords:
[
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
---
title: Overview
slug: /docs
title: Framework
slug: /developer/framework/
description: Jan Docs | Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
]
---

The following low-level docs are aimed at core contributors.
Expand Down
File renamed without changes
61 changes: 0 additions & 61 deletions docs/docs/guides/00-overview.md

This file was deleted.

98 changes: 0 additions & 98 deletions docs/docs/guides/02-installation/01-mac.md

This file was deleted.

Loading
Loading