Spaces:
Runtime error
Runtime error
Update README.md
#6
by
Carsonburney - opened
README.md
CHANGED
|
@@ -1,117 +1,117 @@
|
|
| 1 |
-
---
|
| 2 |
-
sdk: docker
|
| 3 |
-
app_port: 7860
|
| 4 |
-
title: ISA 401
|
| 5 |
-
emoji: 📊
|
| 6 |
-
colorFrom: yellow
|
| 7 |
-
colorTo: yellow
|
| 8 |
-
pinned: false
|
| 9 |
-
license: mit
|
| 10 |
-
short_description: Explore
|
| 11 |
-
---
|
| 12 |
-
|
| 13 |
-
# ISA 401 OEWS Jobs Explorer
|
| 14 |
-
|
| 15 |
-
**Your AI-Powered Assistant for Exploring Occupational Employment and Wage Statistics**
|
| 16 |
-
|
| 17 |
-
[](https://huggingface.co/spaces/fmegahed/querychat_demo)
|
| 18 |
-
|
| 19 |
-
Explore the U.S. Bureau of Labor Statistics' Occupational Employment and Wage Statistics (OEWS) dataset using natural language queries.
|
| 20 |
-
|
| 21 |
-
---
|
| 22 |
-
|
| 23 |
-
## What is this app?
|
| 24 |
-
|
| 25 |
-
This Shiny application uses AI-powered natural language processing to help you explore the OEWS dataset. Instead of writing SQL queries, simply ask questions in plain English and get instant results.
|
| 26 |
-
|
| 27 |
-
**Example queries:**
|
| 28 |
-
- "What are the top 10 highest paying occupations in Ohio?"
|
| 29 |
-
- "Show me employment by industry for software developers"
|
| 30 |
-
- "What is the median wage for nurses nationally?"
|
| 31 |
-
- "Compare wages between California and Texas for data scientists"
|
| 32 |
-
|
| 33 |
-
---
|
| 34 |
-
|
| 35 |
-
## Dataset Information
|
| 36 |
-
|
| 37 |
-
**Dataset:** Occupational Employment and Wage Statistics (OEWS) Survey (May 2024 Estimates)
|
| 38 |
-
**Publisher:** U.S. Bureau of Labor Statistics (BLS), Department of Labor
|
| 39 |
-
**Website:** https://www.bls.gov/oes/
|
| 40 |
-
|
| 41 |
-
The OEWS program produces employment and wage estimates annually for over 800 occupations. These estimates are available for the nation as a whole, for individual states, and for metropolitan and nonmetropolitan areas.
|
| 42 |
-
|
| 43 |
-
### Key Fields
|
| 44 |
-
|
| 45 |
-
| Field | Description |
|
| 46 |
-
|-------|-------------|
|
| 47 |
-
| `occ_title` | Occupation title |
|
| 48 |
-
| `area_title` | Geographic area name |
|
| 49 |
-
| `tot_emp` | Total employment |
|
| 50 |
-
| `a_mean` | Mean annual wage |
|
| 51 |
-
| `a_median` | Median annual wage |
|
| 52 |
-
| `h_mean` | Mean hourly wage |
|
| 53 |
-
|
| 54 |
-
---
|
| 55 |
-
|
| 56 |
-
## Features
|
| 57 |
-
|
| 58 |
-
- **Natural Language Queries**: Ask questions in plain English
|
| 59 |
-
- **SQL Transparency**: See the generated SQL for each query
|
| 60 |
-
- **Interactive Data Table**: Sort, filter, and export results
|
| 61 |
-
- **Miami University Theming**: Branded for ISA 401 course use
|
| 62 |
-
|
| 63 |
-
---
|
| 64 |
-
|
| 65 |
-
## Running Locally
|
| 66 |
-
|
| 67 |
-
**With R:**
|
| 68 |
-
```r
|
| 69 |
-
# Install dependencies
|
| 70 |
-
renv::restore()
|
| 71 |
-
|
| 72 |
-
# Run the app
|
| 73 |
-
shiny::runApp('.', host = '0.0.0.0', port = 7860)
|
| 74 |
-
```
|
| 75 |
-
|
| 76 |
-
**With Docker:**
|
| 77 |
-
```bash
|
| 78 |
-
# Build the image
|
| 79 |
-
docker build -t oews-explorer .
|
| 80 |
-
|
| 81 |
-
# Run with OpenAI API key
|
| 82 |
-
docker run --rm -p 7860:7860 -e OPENAI_API_KEY=$OPENAI_API_KEY oews-explorer
|
| 83 |
-
```
|
| 84 |
-
|
| 85 |
-
---
|
| 86 |
-
|
| 87 |
-
## Required Environment Variable
|
| 88 |
-
|
| 89 |
-
This app requires an OpenAI API key to function:
|
| 90 |
-
|
| 91 |
-
```bash
|
| 92 |
-
export OPENAI_API_KEY="your-api-key-here"
|
| 93 |
-
```
|
| 94 |
-
|
| 95 |
-
On Hugging Face Spaces, set this as a secret in your Space settings.
|
| 96 |
-
|
| 97 |
-
---
|
| 98 |
-
|
| 99 |
-
## Technology Stack
|
| 100 |
-
|
| 101 |
-
- **[Shiny](https://shiny.posit.co/)** - Web application framework for R
|
| 102 |
-
- **[querychat](https://github.com/posit-dev/querychat)** - Natural language data querying
|
| 103 |
-
- **[bslib](https://rstudio.github.io/bslib/)** - Bootstrap theming for Shiny
|
| 104 |
-
- **[DT](https://rstudio.github.io/DT/)** - Interactive data tables
|
| 105 |
-
|
| 106 |
-
---
|
| 107 |
-
|
| 108 |
-
## Course Information
|
| 109 |
-
|
| 110 |
-
This application was developed for **ISA 401** at **Miami University** to help students explore and understand labor market data using modern AI-powered tools.
|
| 111 |
-
|
| 112 |
-
---
|
| 113 |
-
|
| 114 |
-
## Data Source
|
| 115 |
-
|
| 116 |
-
Bureau of Labor Statistics, U.S. Department of Labor. *Occupational Employment and Wage Statistics (OEWS), May 2024 Estimates.*
|
| 117 |
-
https://www.bls.gov/oes/
|
|
|
|
| 1 |
+
---
|
| 2 |
+
sdk: docker
|
| 3 |
+
app_port: 7860
|
| 4 |
+
title: ISA 401 Airbnb asmt
|
| 5 |
+
emoji: 📊
|
| 6 |
+
colorFrom: yellow
|
| 7 |
+
colorTo: yellow
|
| 8 |
+
pinned: false
|
| 9 |
+
license: mit
|
| 10 |
+
short_description: Explore Columbus Airbnb Options
|
| 11 |
+
---
|
| 12 |
+
|
| 13 |
+
# ISA 401 OEWS Jobs Explorer
|
| 14 |
+
|
| 15 |
+
**Your AI-Powered Assistant for Exploring Occupational Employment and Wage Statistics**
|
| 16 |
+
|
| 17 |
+
[](https://huggingface.co/spaces/fmegahed/querychat_demo)
|
| 18 |
+
|
| 19 |
+
Explore the U.S. Bureau of Labor Statistics' Occupational Employment and Wage Statistics (OEWS) dataset using natural language queries.
|
| 20 |
+
|
| 21 |
+
---
|
| 22 |
+
|
| 23 |
+
## What is this app?
|
| 24 |
+
|
| 25 |
+
This Shiny application uses AI-powered natural language processing to help you explore the OEWS dataset. Instead of writing SQL queries, simply ask questions in plain English and get instant results.
|
| 26 |
+
|
| 27 |
+
**Example queries:**
|
| 28 |
+
- "What are the top 10 highest paying occupations in Ohio?"
|
| 29 |
+
- "Show me employment by industry for software developers"
|
| 30 |
+
- "What is the median wage for nurses nationally?"
|
| 31 |
+
- "Compare wages between California and Texas for data scientists"
|
| 32 |
+
|
| 33 |
+
---
|
| 34 |
+
|
| 35 |
+
## Dataset Information
|
| 36 |
+
|
| 37 |
+
**Dataset:** Occupational Employment and Wage Statistics (OEWS) Survey (May 2024 Estimates)
|
| 38 |
+
**Publisher:** U.S. Bureau of Labor Statistics (BLS), Department of Labor
|
| 39 |
+
**Website:** https://www.bls.gov/oes/
|
| 40 |
+
|
| 41 |
+
The OEWS program produces employment and wage estimates annually for over 800 occupations. These estimates are available for the nation as a whole, for individual states, and for metropolitan and nonmetropolitan areas.
|
| 42 |
+
|
| 43 |
+
### Key Fields
|
| 44 |
+
|
| 45 |
+
| Field | Description |
|
| 46 |
+
|-------|-------------|
|
| 47 |
+
| `occ_title` | Occupation title |
|
| 48 |
+
| `area_title` | Geographic area name |
|
| 49 |
+
| `tot_emp` | Total employment |
|
| 50 |
+
| `a_mean` | Mean annual wage |
|
| 51 |
+
| `a_median` | Median annual wage |
|
| 52 |
+
| `h_mean` | Mean hourly wage |
|
| 53 |
+
|
| 54 |
+
---
|
| 55 |
+
|
| 56 |
+
## Features
|
| 57 |
+
|
| 58 |
+
- **Natural Language Queries**: Ask questions in plain English
|
| 59 |
+
- **SQL Transparency**: See the generated SQL for each query
|
| 60 |
+
- **Interactive Data Table**: Sort, filter, and export results
|
| 61 |
+
- **Miami University Theming**: Branded for ISA 401 course use
|
| 62 |
+
|
| 63 |
+
---
|
| 64 |
+
|
| 65 |
+
## Running Locally
|
| 66 |
+
|
| 67 |
+
**With R:**
|
| 68 |
+
```r
|
| 69 |
+
# Install dependencies
|
| 70 |
+
renv::restore()
|
| 71 |
+
|
| 72 |
+
# Run the app
|
| 73 |
+
shiny::runApp('.', host = '0.0.0.0', port = 7860)
|
| 74 |
+
```
|
| 75 |
+
|
| 76 |
+
**With Docker:**
|
| 77 |
+
```bash
|
| 78 |
+
# Build the image
|
| 79 |
+
docker build -t oews-explorer .
|
| 80 |
+
|
| 81 |
+
# Run with OpenAI API key
|
| 82 |
+
docker run --rm -p 7860:7860 -e OPENAI_API_KEY=$OPENAI_API_KEY oews-explorer
|
| 83 |
+
```
|
| 84 |
+
|
| 85 |
+
---
|
| 86 |
+
|
| 87 |
+
## Required Environment Variable
|
| 88 |
+
|
| 89 |
+
This app requires an OpenAI API key to function:
|
| 90 |
+
|
| 91 |
+
```bash
|
| 92 |
+
export OPENAI_API_KEY="your-api-key-here"
|
| 93 |
+
```
|
| 94 |
+
|
| 95 |
+
On Hugging Face Spaces, set this as a secret in your Space settings.
|
| 96 |
+
|
| 97 |
+
---
|
| 98 |
+
|
| 99 |
+
## Technology Stack
|
| 100 |
+
|
| 101 |
+
- **[Shiny](https://shiny.posit.co/)** - Web application framework for R
|
| 102 |
+
- **[querychat](https://github.com/posit-dev/querychat)** - Natural language data querying
|
| 103 |
+
- **[bslib](https://rstudio.github.io/bslib/)** - Bootstrap theming for Shiny
|
| 104 |
+
- **[DT](https://rstudio.github.io/DT/)** - Interactive data tables
|
| 105 |
+
|
| 106 |
+
---
|
| 107 |
+
|
| 108 |
+
## Course Information
|
| 109 |
+
|
| 110 |
+
This application was developed for **ISA 401** at **Miami University** to help students explore and understand labor market data using modern AI-powered tools.
|
| 111 |
+
|
| 112 |
+
---
|
| 113 |
+
|
| 114 |
+
## Data Source
|
| 115 |
+
|
| 116 |
+
Bureau of Labor Statistics, U.S. Department of Labor. *Occupational Employment and Wage Statistics (OEWS), May 2024 Estimates.*
|
| 117 |
+
https://www.bls.gov/oes/
|