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.

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

chore: update documentation #693

Merged
merged 1 commit into from
Oct 9, 2024
Merged
Changes from all commits
Commits
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
40 changes: 10 additions & 30 deletions api/registry/bulk-mbd-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@ This document outlines the process for uploading a CSV file to the Django admin

- Access to the Django admin interface at api.scorer.gitcoin.co
- A CSV file containing the data to be processed
- API key (found in 1Password)

## Steps

### 1. Login to Django Admin

1. Open your web browser and navigate to [api.scorer.gitcoin.co](https://api.scorer.gitcoin.co)
1. Open your web browser and navigate to [api.scorer.gitcoin.co/admin](https://api.scorer.gitcoin.co/admin)
2. Log in with your google account

### 2. Navigate to Batch Model Scoring Request
Expand All @@ -27,37 +26,18 @@ This document outlines the process for uploading a CSV file to the Django admin
- Upload your CSV file
3. Click "Save" to submit the form

expected csv format:

```
Address
0x1234
0x5678
```

### 4. Check Result Status

After saving, you will be redirected to a page showing:

- The progress of the processing
- A link to the uploaded file in S3
- A link to the results file

### 5. Query Recent Uploads (Optional)

You can also check the status of recent uploads using an API endpoint:

1. Open a terminal
2. Run the following curl command:

```bash
curl -X 'GET' \
'http://localhost:8002/internal/analysis/batch?limit=10' \
-H 'accept: application/json' \
-H 'AUTHORIZATION: abc'
```

Note: Replace `abc` with your actual API key from 1Password

3. The response will include:
- Links to the uploaded and results files
- The current status of the processing

## Downloading Results

Once the processing is complete, you can download the results file using the link provided in step 4 or in the API response from step 5.

## Troubleshooting

If you encounter any issues during this process, please contact the engineering team for assistance.
Loading