Overview
what is my-own-assistant?
my-own-assistant is a template for creating FastAPI-based API servers, designed to support both CPU and GPU-accelerated setups automatically.
how to use my-own-assistant?
To use my-own-assistant, replace all instances of py-api-template in the codebase and optionally rename the src folder for better organization. Ensure the virtual environment is active and run poetry install before executing commands.
key features of my-own-assistant?
- Automatic support for CPU/GPU-accelerated setups.
- Utilizes Poetry for package management.
- Includes Ruff for code formatting and linting.
- Provides VSCode debugging tasks.
- Compatible with Dev Containers for easy setup.
use cases of my-own-assistant?
- Building scalable web APIs with FastAPI.
- Developing machine learning applications that require GPU acceleration.
- Setting up a development environment using Docker and VSCode.
FAQ from my-own-assistant?
- What is FastAPI?
FastAPI is a modern web framework for building APIs with Python 3.6+ based on standard Python type hints.
- How do I run tests?
You can run tests using the command
poe testafter ensuring the virtual environment is active.
- Can I deploy my API using Docker?
Yes! You can build and run your Docker image using the provided commands.