ml_streamlit/docs/getting-started.md

45 lines
939 B
Markdown

# Getting Started
## Prerequisites
- Python 3.7+
- Streamlit
- Scikit-learn
- Joblib
## Installation
1. Clone the repository
2. Install dependencies:
```bash
pip install -r requirements.txt
```
## Running the Application
Run the Streamlit application with:
```bash
streamlit run streamlit.py
```
The application will open in your default web browser, typically at http://localhost:8501.
## Development
To modify the application:
1. Edit the `streamlit.py` file to change the UI or functionality
2. The application will automatically reload when you save changes
## Deployment
Streamlit applications can be deployed in several ways:
1. **Streamlit Sharing**: A free hosting service for Streamlit apps
2. **Heroku**: Deploy using a Procfile and requirements.txt
3. **Docker**: Containerize the application for deployment anywhere
For deployment, ensure that the model and scaler files are included with the application code.