feat: SF 311 Calls - Predicting the number of calls per category usin…

…g LSTM (#293)
GoogleCloudPlatform · Feb 15, 2022 · 88637ca · 88637ca
1 parent dfda5d9
commit 88637ca
Show file tree

Hide file tree

Showing 8 changed files with 1,236 additions and 35 deletions.
diff --git a/.flake8 b/.flake8
@@ -16,7 +16,7 @@
 
 [flake8]
 max-line-length = 88
-ignore = E203, E266, E501, W503
+ignore = E203, E266, E501, W503, E402
 exclude =
  # Exclude generated code.
  .dev/**

diff --git a/.github/workflows/python-lint.yaml b/.github/workflows/python-lint.yaml
@@ -9,7 +9,7 @@ jobs:
  uses: actions/setup-python@v2
  - name: Install dependencies
  run:
- python -m pip install flake8 isort
+ python -m pip install flake8 isort nbqa
  - uses: psf/black@stable
  with:
  args: ". --check"
@@ -18,3 +18,5 @@ jobs:
  run: flake8
  - name: Run isort
  run: isort --check-only --profile black --diff .
+ - name: Run flake8 on notebooks
+ run: nbqa flake8 .
diff --git a/Pipfile b/Pipfile
@@ -24,6 +24,8 @@ pytest = "*"
 "ruamel.yaml" = "==0.17.11"
 Jinja2 = "==2.11.3"
 SQLAlchemy = "==1.3.24"
+testbook = "*"
+jupyter = "*"
 
 [requires]
 python_version = "3.8"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/datasets/san_francisco_311/docs/overview/overview.md b/datasets/san_francisco_311/docs/overview/overview.md
@@ -0,0 +1,38 @@
+## Overview
+This data includes all San Francisco 311 service requests from July 2008 to the present,
+and is updated daily.
+311 is a non-emergency number that provides access to non-emergency municipal services.
+
+This public dataset is hosted in Google BigQuery and is included in BigQuery's 1TB/mo
+of free tier processing. This means that each user receives 1TB of free BigQuery
+processing every month, which can be used to run queries on this public dataset.
+
+## Dataset Details
+
+| Attribute | Value |
+|---------------------------|---------------|
+| Dataset Type | Tabular |
+| Category | Public safety |
+| Dataset source | DataSF |
+| Cloud service | BigQuery |
+| Expected update frequency | Daily |
+
+## Main Columns
+This dataset has over 20 columns. Here are some of the main columns in the dataset:
+
+| Column | Type | Description |
+|--------------|-----------|-------------------------------------------------------------------|
+| created_date | TIMESTAMP | The time and date of when the entry was added to the table |
+| closed_date | TIMESTAMP | The time and date of when the status was changed to `Closed` |
+| status | STRING | Either `Open` or `Closed` |
+| category | STRING | The call category, e.g. `Abandoned Vehicle` or `Tree Maintenance` |
+| neighborhood | STRING | The the neighborhood name for the incident |
+| latitude | FLOAT | The latitude for the incident |
+| longitude | FLOAT | The longitude for the incident |
+
+
+## Terms of Service
+This dataset is publicly available for anyone to use under the following terms
+provided by the Dataset Source - http://sfgov.org/ - and is provided "AS IS"
+without any warranty, express or implied, from Google. Google disclaims all
+liability for any damages, direct or indirect, resulting from the use of the dataset.
diff --git a/datasets/san_francisco_311/docs/tutorials/predict_weekly_calls/artifact.yaml b/datasets/san_francisco_311/docs/tutorials/predict_weekly_calls/artifact.yaml
@@ -0,0 +1,23 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+artifact:
+ title: "Predicting the Weekly 311 Calls in San Francisco"
+ description: "Train a LSTM model to predict the number of 311 calls in San Francisco based on the call category."
+ tags:
+ - ml:forecasting
+ - ml:lstm
+ - libraries:tensorflow
+ - vertical:government
+ - tier:free