tcsenpai/pensieve
1
0
Fork 0
mirror of https://github.com/tcsenpai/pensieve.git synced 2025-06-06 19:25:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated instructions

Browse Source
This commit is contained in:
tcsenpai 2024-11-17 20:07:27 +01:00
parent 86dcd79923
commit e9e83306c1
1 changed files with 41 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -26,15 +26,17 @@ This project draws heavily from two other projects: one called [Rewind](https://
## Quick Start ## Quick Start
### MacOS & Windows
![memos-installation](docs/images/memos-installation.gif) ![memos-installation](docs/images/memos-installation.gif)
### 1. Install Pensieve #### 1. Install Pensieve
```sh ```sh
pip install memos pip install memos
``` ```
### 2. Initialize #### 2. Initialize
Initialize the pensieve configuration file and sqlite database: Initialize the pensieve configuration file and sqlite database:
@ -44,7 +46,7 @@ memos init
Data will be stored in the `~/.memos` directory. Data will be stored in the `~/.memos` directory.
### 3. Start the Service #### 3. Start the Service
```sh ```sh
memos enable memos enable
@ -57,6 +59,32 @@ This command will:
- Start the Web service - Start the Web service
- Set the service to start on boot - Set the service to start on boot
### Linux
**Note:** Linux support is still under development. At the moment, you can run the app by following the steps below.
**Important:** You need to have `conda` installed to run the app. Also, if something is not working, check the single commands in the shell files to see if they are working.
- [x] Tested on Ubuntu 22.04 + KDE Plasma + Wayland
#### 1. Install Dependencies
```sh
./linuxdeps.sh
```
#### 2. Install Pensieve
```sh
./local_setup.sh
```
#### 3. Start the App
```sh
source start.sh
```
### 4. Access the Web Interface ### 4. Access the Web Interface
Open your browser and visit `http://localhost:8839` Open your browser and visit `http://localhost:8839`
@ -88,9 +116,9 @@ Open the `~/.memos/config.yaml` file with your preferred text editor and modify
embedding: embedding:
enabled: true enabled: true
use_local: true use_local: true
model: jinaai/jina-embeddings-v2-base-en # Model name used model: jinaai/jina-embeddings-v2-base-en # Model name used
num_dim: 768 # Model dimensions num_dim: 768 # Model dimensions
use_modelscope: false # Whether to use ModelScope's model use_modelscope: false # Whether to use ModelScope's model
``` ```
#### 3. Restart Memos Service #### 3. Restart Memos Service
@ -153,11 +181,11 @@ Open the `~/.memos/config.yaml` file with your preferred text editor and modify
```yaml ```yaml
vlm: vlm:
enabled: true # Enable VLM feature enabled: true # Enable VLM feature
endpoint: http://localhost:11434 # Ollama service address endpoint: http://localhost:11434 # Ollama service address
modelname: minicpm-v # Model name to use modelname: minicpm-v # Model name to use
force_jpeg: true # Convert images to JPEG format to ensure compatibility force_jpeg: true # Convert images to JPEG format to ensure compatibility
prompt: Please describe the content of this image, including the layout and visual elements # Prompt sent to the model prompt: Please describe the content of this image, including the layout and visual elements # Prompt sent to the model
``` ```
Use the above configuration to overwrite the `vlm` configuration in the `~/.memos/config.yaml` file. Use the above configuration to overwrite the `vlm` configuration in the `~/.memos/config.yaml` file.
@ -166,8 +194,8 @@ Also, modify the `default_plugins` configuration in the `~/.memos/plugins/vlm/co
```yaml ```yaml
default_plugins: default_plugins:
- builtin_ocr - builtin_ocr
- builtin_vlm - builtin_vlm
``` ```
This adds the `builtin_vlm` plugin to the default plugin list. This adds the `builtin_vlm` plugin to the default plugin list.