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.

Sign up for GitHub

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

Update MDK docs to consider new allora-mdk repo #99

Merged
merged 2 commits into from
Feb 27, 2025
Merged

Update MDK docs to consider new allora-mdk repo #99

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e746bd6
Update mdk docs to consider new repo
guilherme-brandao Jan 17, 2025
1801335
Merge branch 'main' into update-mdk-docs
kpeluso Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 3 additions & 23 deletions pages/devs/workers/deploy-worker/allora-mdk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ Although these models are already integrated into the MDK, you can add more mode
Run the following commands in a new terminal window:

```bash
git clone https://github.com/allora-network/allora-model-maker.git
cd allora-model-maker
git clone https://github.com/allora-network/allora-mdk.git
cd allora-mdk
```

#### Conda not Installed?
Expand Down Expand Up @@ -190,31 +190,11 @@ Replace arima with the name of the model you’d like to package (e.g., lstm, xg
<Callout>
This will:

- Copy the model’s files and dependencies into the `packaged_models/package folder`.
- Copy the model’s files and dependencies into the `package folder`.
- Run test's for inference and training to validate functionality in a worker
- Generate a configuration file, `config.py`, that contains the active model information.
</Callout>

### Clone the Allora Worker Repository

Run the following commands in a new terminal window:

```bash
git clone https://github.com/allora-network/allora-worker.git
cd allora-worker
```

### Integrate your Model

After running the packaging command:

1. Navigate to the packaged_models folder in your allora-model-maker repo.
2. Copy the package folder into the src folder of your allora-worker repository.

<Callout type='info'>
If you did this right in your allora-worker repo you'll now have `allora-worker/src/package`
</Callout>

### Deploy your Worker

#### Expose the Endpoint
Expand Down