ReMe/docs/installation.md

Installing MemoryScope

I. Install with docker [Recommended]

1. Clone the repository and edit settings

   # clone project
   git clone https://github.com/modelscope/memoryscope
   cd memoryscope
   # edit configuration, e.g. add api keys
   vim memoryscope/core/config/demo_config_zh.yaml
   

2. Build Docker image

   sudo docker build --network=host -t memoryscope .
   

3. Launch Docker container

   sudo docker run -it --rm --net=host memoryscope
   

II. Install with docker compose [Recommended]

1. Clone the repository and edit settings

   # clone project
   git clone https://github.com/modelscope/memoryscope
   cd memoryscope
   # edit configuration, e.g. add api keys
   vim memoryscope/core/config/demo_config_zh.yaml
   

2. Edit docker-compose.yml to change environment variable.

   DASHSCOPE_API_KEY: "sk-0000000000"
   

3. Run docker-compose up to build and launch the memory-scope cli interface.

III. Install from PYPI [Linux only]

1. Install from pypi:

   pip install memoryscope
   

2. test Chinese / Dashscope chat configuration:

   export DASHSCOPE_API_KEY="sk-0000000000"
   memoryscope --config_path=memoryscope/core/config/demo_config_zh.yaml
   

3. test English / OpenAI chat configuration:

   export OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
   python quick-start-demo.py --config_path=memoryscope/core/config/demo_config.yaml
   

IV. Install from source [Linux only]

1. Clone the repository and edit settings

   # clone project
   git clone https://github.com/modelscope/memoryscope
   cd memoryscope
   # edit configuration, e.g. add api keys
   vim memoryscope/core/config/demo_config_zh.yaml
   

2. Install

   poetry install
   

3. Run Elasticsearch service, refer to elasticsearch documents. The docker method is recommended:

   sudo docker run -p 9200:9200 \
   -e "discovery.type=single-node" \
   -e "xpack.security.enabled=false" \
   -e "xpack.license.self_generated.type=trial" \
   docker.elastic.co/elasticsearch/elasticsearch:8.13.2
   

4. Launch memoryscope, also refer to cli documents

   pip install -r requirements.txt
   export DASHSCOPE_API_KEY="sk-0000000000"
   python quick-start-demo.py --config_path=memoryscope/core/config/demo_config_zh.yaml