Skip to content

Street Smarts lets you compare car cost, features and CO2 emissions—all in one place.

License

Notifications You must be signed in to change notification settings

BloomTech-Labs/street-smarts-ds

Repository files navigation

Street Smarts

You can find the project at streetsmarts.online.

streetsmartsgif

Contributors

Will Stauffer-Norris Jon Nguyen Mikio Harman

MIT Python Scikit-Learn FastAPI FuzzyWuzzy Pandas Heroku

More info on using badges here

Project Overview

Trello Board

Product Canvas

Street Smarts helps you discover the value and carbon emissions of your car, and compare it to other cars.

We use deep learning in our state-of-the-art machine learning model to predict current prices.

Unlike the dealers, we also display the carbon emissions for your car, so you can make a responsible purchase.

Deployed Front End

Tech Stack

Predictions

# Input 

{
'make': 'Ford',
'model': 'F150 Pickup 4WD'
'year': 2005
}
# Outputting Route

{
  "car_price_prediction": 30655.23,
  "fuel_cost": 16071.43,
  "maintenance_cost": 1000,
  "five_year_cost_to_own": 47726.66,
  "co2_five_year_kgs": 47608.93,
  "number_of_trees_to_offset": 437,
  "list_of_imgs": [
    "https://images.craigslist.org/00l0l_aZwW2Ok8T8T_600x450.jpg",
    "https://images.craigslist.org/00l0l_aZwW2Ok8T8T_600x450.jpg"
  ]
}

Explanatory Variables

  1. Model
    • This is the model of the vehicle.
  2. Make
    • This is the make of the vehicle.
  3. Year
    • The year of the vehicle.

Data Sources

Python Notebooks

Official_大_Data_ 🧮_Cleaning_🧹_Notebook_📓

SQL

Plotly Dash App Data Viz 📉

streetsmart_EPA_vehicles_EDA

official_streetsmarts_pytest

How to connect to the data API

Our initial release canvases included a Flask API with dummy endpoints to Heroku, hosting a database on there as well.

To access the version of the repo that was deployed to Heroku:
clone the repo
access our commit with:
git checkout 1ff857091d07a4e13455aeba0e7bc4b0137434be

https://streetsmartdummy.herokuapp.com/pred

Example Input:

{
	"make":"this is a test",
	"model": "ford",
	"year":1995,
	"fuel_type":"gas",
	"state":"CA",
	"mileage":100
}

Example Output:

{
    "cost_to_own": -14698.94,
    "predicted_CO2_emissions": 11,
    "predicted_gas_cost": 4399.88,
    "predicted_kWh": 205.37,
    "predicted_price": -20000
}

Our current FAST api is deployed on AWS with easily accessed docs at:

http://data.streetsmarts.online/docs

Input:

miles_per_year: int = 15000,
num_years: int = 5,
gas_cost: int = 3,
electrical_cost: float = 0.12,
maintenance_cost_per_year: int = 1000,
make: str='Ford',
model: str='F150 Pickup 4WD',
year: int=2005,
odometer: int=99999
}

Output:

{
  "car_price_prediction": 30655.23,
  "fuel_cost": 16071.43,
  "maintenance_cost": 1000,
  "five_year_cost_to_own": 47726.66,
  "co2_five_year_kgs": 47608.93,
  "number_of_trees_to_offset": 437,
  "trees_burned_emoji": [
    "🔥🔥🔥🔥🌲🌲🌲🌲🌲🌲"
  ],
  "list_of_imgs": [
    "https://images.craigslist.org/00E0E_av8sHn7jwty_600x450.jpg"
  ]
}

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

  • Check first to see if your issue has already been reported.
  • Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
  • Create a live example of the problem.
  • Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number, if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.

See Front End Documentation for details on the front end of our project.

About

Street Smarts lets you compare car cost, features and CO2 emissions—all in one place.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages