Skip to content

Commit

Permalink
Document Sync by Tina
Browse files Browse the repository at this point in the history
  • Loading branch information
Chivier committed Nov 3, 2024
1 parent 13ee8a7 commit ab449fa
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/stable/developer/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Developer Guide",
"position": 6
}
25 changes: 25 additions & 0 deletions docs/stable/developer/supporting_a_new_hardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 0
---

# Supporting a New Hardware

ServerlessLLM actively expands support for new hardware configurations to meet diverse deployment needs.

## Support Standards
Hardware is considered supported by ServerlessLLM if:
1. Any of the inference backends used (e.g., Transformers, vLLM) can run model inference on the hardware.
2. ServerlessLLM Store can successfully load model checkpoints on the hardware.

## Steps to Support a New Hardware
1. **Check Inference Backend Compatibility**: Refer to the specific inference backend documentation (e.g., for vLLM, Transformers) for hardware support.
2. **ServerlessLLM Store Configuration**:
- If the hardware provides CUDA-compatible APIs (e.g., ROCm), adjust the build script (`CMakeLists.txt`) by adding necessary compiler flags.
- For non-CUDA-compatible APIs, implementing a custom checkpoint loading function might be required.

## Verifying Hardware Support in ServerlessLLM Store
The hardware support is verified if it successfully completes the [Quick Start Guide](https://serverlessllm.github.io/docs/stable/getting_started/quickstart/) examples, showcasing checkpoint loading and inference functionality without errors.

If the hardware is not publicly available (i.e., can't be tested by the ServerlessLLM team), a screenshot or output log of the successful execution of the Quick Start Guide examples is required to verify hardware support.

If you encounter any issues or have questions, please reach out to the ServerlessLLM team by raising an issue on the [GitHub repository](https://github.com/ServerlessLLM/ServerlessLLM/issues).

0 comments on commit ab449fa

Please sign in to comment.