Skip to content

Commit 56ff786

Browse files
Docs: Updating our Install Guide and Quick Start Guide to reflect two packages and more refined download instructions (MemMachine#757)
* Updating the Install Guide for Pip instructions * updating download instructions on QuickStart Guide Signed-off-by: sarah <[email protected]>
1 parent ebd7b78 commit 56ff786

File tree

2 files changed

+15
-11
lines changed

2 files changed

+15
-11
lines changed

docs/getting_started/quickstart.mdx

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,23 @@ Before installing MemMachine, ensure you have the following prerequisites:
3030
<Tab title="Linux/MacOS" icon="linux">
3131
Open your terminal and run the following commands:
3232
```bash
33-
# Download the latest release tarball
34-
curl -s https://api.github.com/repos/MemMachine/MemMachine/releases/latest \
35-
| grep "tarball_url" \
36-
| cut -d '"' -f 4 \
37-
| xargs curl -L -o MemMachine-latest.tar.gz
33+
# Download the latest MemMachine release tarball
34+
TARBALL_URL=$(curl -s https://api.github.com/repos/MemMachine/MemMachine/releases/latest \
35+
| grep '"tarball_url"' \
36+
| head -n 1 \
37+
| sed -E 's/.*"tarball_url": "(.*)",/\1/')
3838

39-
# Extract the release
39+
curl -L "$TARBALL_URL" -o MemMachine-latest.tar.gz
40+
41+
# Extract the release archive
4042
tar -xzf MemMachine-latest.tar.gz
4143

42-
# Enter the folder (GitHub adds a hash to the folder name)
43-
cd MemMachine-MemMachine-*
44+
# Move into the extracted directory (GitHub adds a commit hash to the folder name)
45+
cd MemMachine-MemMachine-*/
4446

45-
# Run the setup script
47+
# Start the MemMachine installation
4648
./memmachine-compose.sh
49+
4750
```
4851
</Tab>
4952
<Tab title="Windows" icon="windows">

docs/install_guide/install_guide.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,15 @@ source memmachine-env/bin/activate # On Windows use `source memmachine-env/Scri
4141
```
4242

4343
A. Run the following command in your terminal:
44+
<Note> Choose the package that is correct for your needs. If you want to install the Client, use `pip install memmachine-client` and if you want to use Server, use `pip install memmachine-server`. Examples below assume server. Should you wish to install client, use the same command, but replace "server" with "client" </Note>
4445

4546
- If you are using MemMachine in a CPU-only environment, use:
4647
```sh
47-
pip install memmachine
48+
pip install memmachine-server
4849
```
4950
- If you have an NVIDIA GPU and want to leverage it, use:
5051
```sh
51-
pip install memmachine[gpu]
52+
pip install memmachine-server[gpu]
5253
```
5354
B. Next, install dependencies from NLTK through the following MemMachine command:
5455
```sh

0 commit comments

Comments
 (0)