Skip to content

Conversation

@Gilfeather
Copy link
Owner

📚 Problem

The current README is missing crucial setup instructions for downloading the ResNet18 ONNX model, which is required for building the project. Users attempting to build would encounter failures due to the missing model file.

🔧 Solution

Added Clear Setup Instructions

  • Step-by-step ResNet18 ONNX model download from official ONNX model zoo
  • Models directory creation command (mkdir -p models)
  • Download verification step to confirm successful download (~45MB file)
  • Updated section numbering to maintain proper sequence

New Quick Start Flow

  1. Clone and Setup
  2. Download ResNet-18 ONNX Model ← NEW
  3. Build with ONNX Support
  4. Generate Test Data
  5. Start the Server
  6. Test the API

📋 Changes

README.md Updates

  • Added comprehensive ResNet18 ONNX download instructions
  • Included curl command to download from official ONNX model zoo
  • Added file size verification (should show ~45MB resnet18.onnx)
  • Updated all subsequent section numbers to maintain sequence

User Experience Improvements

  • ✅ Clear prerequisite setup before building
  • ✅ Official ONNX model zoo source (trusted)
  • ✅ Verification step to confirm successful download
  • ✅ No more mysterious build failures due to missing models

🎯 Expected Results

After this PR:

  • ✅ New users can successfully build the project on first try
  • ✅ Clear understanding of ONNX model requirements
  • ✅ No confusion about where to get the ResNet18 model
  • ✅ Proper setup flow that matches the actual build process

This resolves the gap in documentation that could cause frustration for new users trying to get started with Furnace.

- Add step-by-step ResNet18 ONNX model download instructions
- Include models directory creation command
- Add verification step to confirm successful download
- Update section numbering to maintain proper sequence
- Clarify that ONNX model is required before building

This resolves the issue where users would encounter build failures
due to missing ResNet18 ONNX model file. The instructions now clearly
guide users through downloading the required model from the official
ONNX model zoo before attempting to build the project.
@Gilfeather Gilfeather merged commit 2d3e8cf into main Jul 24, 2025
12 checks passed
@Gilfeather Gilfeather deleted the docs/add-resnet18-download-instructions branch July 24, 2025 07:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants