From a8d5563b18ab0f004d11d3161679957f739c8edd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9D=92=E8=BD=A9?= Date: Thu, 29 Aug 2024 11:32:33 +0800 Subject: [PATCH] remove file --- docs/Installation.md | 86 -------------------------------------------- 1 file changed, 86 deletions(-) delete mode 100644 docs/Installation.md diff --git a/docs/Installation.md b/docs/Installation.md deleted file mode 100644 index 9278d119..00000000 --- a/docs/Installation.md +++ /dev/null @@ -1,86 +0,0 @@ -# Installing MemoryScope - -## I. Install with docker [Recommended] -1. Clone the repository and edit settings - ```bash - # 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 - ```bash - sudo docker build --network=host -t memoryscope . - ``` - - -3. Launch Docker container - ```bash - sudo docker run -it --rm --net=host memoryscope - ``` - - -## II. Install with docker compose [Recommended] - - -1. Clone the repository and edit settings - ```bash - # 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] - -```bash -pip install memoryscope -export DASHSCOPE_API_KEY="sk-0000000000" -memoryscope --config_path=memoryscope/core/config/demo_config_zh.yaml -``` - - -## IV. Install from source [Linux only] - -1. Clone the repository and edit settings - ```bash - # 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 - ```bash - poetry install - ``` - -3. Run Elasticsearch service, refer to [elasticsearch documents](https://www.elastic.co/guide/en/elasticsearch/reference/current/getting-started.html). -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](../examples/cli/README.md) - ```bash - 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 - ```