Coder Social home page Coder Social logo

dtemir / fellowship-prediction Goto Github PK

View Code? Open in Web Editor NEW
49.0 1.0 5.0 2.64 MB

Analyzes your GitHub Profile and presents you with a report on how likely you are to become the next MLH Fellow!

Home Page: https://fellowship-prediction.web.app/

License: MIT License

JavaScript 0.52% HTML 0.53% TypeScript 23.75% CSS 4.71% Jupyter Notebook 49.44% Python 16.30% Shell 3.41% Dockerfile 1.33%
bentoml python flask react heroku firebase

fellowship-prediction's Introduction

Fellowship Prediction

GitHub Profile Comparative Analysis Tool Built with BentoML

Fellowship Prediction Header Logo

Table of Contents:

Winner

This project won the MLH Fellowship Orientation Hackathon - Batch 4 along with other great projects by MLH Fellows. We highly suggest you check them out.

Features

Analyzes your GitHub Profile and presents you with a report on how likely you are to become the next MLH Fellow!

Try it now!

Demo Git

Provides you with an extensive analysis on the following features of your profile:

Feature Description
Commits Number of total commits the user made
Contributions Number of repositories where the user made contributions
Followers Number of followers the user has
Forks Number of forks the user has in their repositories
Issues Number of issues the user has raised
Organizations Number of organizations the user is a part of
Repos Number of repositories the user has
Stars Number of stars the user has on their repositories

And gives you a comprehensive score of how similar your GitHub Profile is to an average MLH Fellow's GitHub.

It also shows your statistics in a user-friendly data visualization format for you to gauge the range of your skills and become the next MLH Fellow!

Disclaimer

Dear user, building this application, we were trying our best to provide with data insights into things you can improve through your GitHub Profile. This is a hackakthon project that is built by Open Source Fellows and is not directly affiliated with MLH in any capacity. The positive score in your application does not guarantee your chances of becoming a fellow because there are external things apart from GitHub that affect the decision process.

We also hope that you understand that your GitHub Stats do not affect your value to the community as a developer. We all have different paths to success in our lives, and they do not necessarily involve high scores. Regardless of your numbers, you are going to succeed in your journey.

Technologies Used

Tech Stack Used

We used the following technologies:

  • BentoML along with Heroku to build an API endpoint that calculates the comprehensive score for the user based on a simple query.
  • Flask deployed to Heroku to setup a bridge between the frameworks and collect the input data.
  • React.js served on Firebase to provide user-friendly UI for future MLH fellows to use.

Contributing

To contribute to this open-source project, follow these steps:

  1. Fork the repository.
  2. Create a branch: git checkout -b <branch_name>.
  3. Make your changes and commit them: git commit -m '<commit_message>'.
  4. Push to your branch: git push origin <project_name>/<location>.
  5. Create a pull request.

To work on BentoML:

  1. Go to model/bento_deploy to find necessary files.
  2. Read BentoML Start Guide to learn more about the files.
  3. Improve the BentoML Interface to provide our users with a more accurate score.
  4. Create the BentoML prediction service with python bento_packer.py and commit the saved class from bentoml get IrisClassifier:latest --print-location --quiet.

To work on the Back-End:

  1. Consult scr/server and its README.
  2. Make contributions.

Alternatively: Reach out to one of the Project Contributors for questions.

Demo

YouTube Logo that Leads to our demo

Motivation

We built this project because we wanted to help prospective MLH Fellows with their progress toward a better GitHub profile with solid projects and a record of active work. We also wanted to give them some insights into what an average fellow at MLH looks like.

When we were just aspiring to become MLH Fellows, we would look for different sources of information to know what MLH is looking for in their fellows and better ways to prepare. So we tried to address this issue and hopefully support future fellows on their way to success.

However, we make an important notion that your GitHub Profile does not define you as a developer. Our tool is simply to let you see into the data for areas of potential improvement and keep working toward your goals. We do not consider things like:

  • Personal communication levels
  • Spot availability
  • Match in project interests

The mentioned points affect your chances on becoming a fellow. Unfortunately, there is no way to take them into consideration.

Team

Damir Temir


Damir Temir

Working on the project, I learned the basics of BentoML and deploying the server model to the cloud like Heroku. I also gained some experience in Data Mining and Processing, which is an invaluable skill toward my journey to Machine Learning Engineering.

The contributions I made are:

  • Wrote Jupyter Notebooks where we showcase our work with the GitHub API.
  • Set up a Git repository with active GitHub Projects and proper infrastructure.
  • Mined data on more than 650 fellows in the MLH Fellowship organization.
  • Created a BentoML API node deployed to Heroku for querying.

Aymen Bennabi


Aymen Bennabi

During the hackathon I majorly worked on the Front-End part of the project. I created a friendly UI/UX to collect data and visualize the results. Also, I helped a little bit with the Back-End by creating a facade API to make working with GitHub easier. The new interface adds a level of abstraction that mainly focuses on quantitative data that we needed to do the statistical analysis.

I really enjoyed the Orientation Hackathon. I now feel more confident working with Git/GitHub. I also started learning about functional programming base API (OCamal/dream).

Tasha Kim


Aymen Bennabi

Utilizing BentoML gave us a flexible, high-performance framework to serve, manage, and deploy our model to predict MLH fellowship status using user's GitHub profiles. In particular, I enjoyed working with ML frameworks like Matplotlib, Seaborn, and Pandas, as well as Cloud native deployment services, and API serving that were all packaged into a single service.

Some of my contributions were:

  • Implemented the ANNOVA model as an alternative improved statiscal comparison to the one we are using now. Our current one works fine, but we can use this in the case we want a more rigorous and detailed comparison (multiple pairwise comparison (post hoc comparison) analysis for all unplanned comparison using Tukey’s honestly significantly differenced (HSD) test).
  • Built a CI (continuous integration) pipeline for build, run, and testing of our node app as well as python app using github actions.
  • Implemented method to compute average statistics for aggregated mlh fellow data.

Shout out to everyone in our team!

Eyimofe Ogunbiyi


Eyimofe Bennabi

I worked on the Back-End Server for the project and the deployment pipeline on Heroku. I was able to use the Flask Rest Framework for the Back-End which was a new experience for me.

License

This project is served under the MIT License.

MIT License

Copyright (c) 2021 Damir Temir

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

fellowship-prediction's People

Contributors

bennaaym avatar dtemir avatar mofe64 avatar tashakim avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

fellowship-prediction's Issues

"Invalid username"

When I enter my username ("stevekm"), I get the error message "invalid username please try again"

Any ideas?

Issue Related To Directory Structure Conventions

  • I'm submitting a ...

    • bug report
    • feature request
    • support request
  • What is the current behavior?

    • Some code files (.py, Procfile) are placed in the repo root folder.
    • Some debugging files (.src/server/api/pycache) were committed
  • What is the expected behavior?

    • All code related files should take place inside the src/ folder
    • Debugging-related files should be added inside a .gitignore file

Need to Get Data from the API

  • I'm submitting a ...

    • bug report
    • feature request
    • support request
  • What is the current behavior?

Right now, we do not have data to build a statistical comparison model. We need data about MLH Fellows from GitHub API.

  • What is the expected behavior?

We need information like:

  • No. Followers
  • No. of Repos
  • No. of Stars
  • No. of Forks to User’s Repository
  • No. of Commits
  • No. of PullRequests
  • No. of Issues
  • No. of Organizations
  • What is the motivation / use case for changing the behavior?

We will be able to use those queries to build a dataset to use later on

Fellow Prediction Form does not recognize github username

The fellow prediction form does not recognize my username, ez2rok, when I put it into the form. This raises an error and prevents me from filling out the form. I tried this on both Brave and Safari.

Any idea what could be causing this kind of error?

Bug: CORS policy blocks client's requests to the prediction backend

I'm submitting a ...

  • bug report
  • feature request
  • support request

What is the current behavior?

The https://fellowship-prediction.web.app website can not fetch the /profile backend endpoint. Seemingly blocked by the CORS policy according to the CORS error message in Figure 2.

image

Figure 1: current behavior

image

Figure 2: CORS error message

image

Figure 3: /profile request payload

If the current behavior is a bug, please provide the steps to reproduce it

Go to https://fellowship-prediction.web.app/form and enter a Github username. You will see an "Invalid Username Please Try Again" modal like Figure 1.

Issue : problem with the structure of data coming from backend

  • I'm submitting a ...

    • bug report
    • feature request
    • support request
  • What is the current behavior?

  • The data coming from the API have the following structure

  • {
    "user": {
    "score": 0,
    "features": {
    "Followers": 3,
    "Repos": 11,
    "Stars": 3,
    "Forks": 0,
    "Commits": 289,
    "Issues": 0,
    "Contributions": 0,
    "Organizations": 1
    }
    },
    "averageFellow": {
    "user": {
    "score": 0,
    "features": {
    "Commits": 892,
    "Followers": 54,
    "Repos": 43,
    "Stars": 26,
    "Forks": 9,
    "Organizations": 1,
    "Issues": 104,
    "Contributions": 86
    }
    }
    }
    }

  • If the current behavior is a bug, please provide the steps to reproduce it

  • the JSON format should be changed on the API
  • What is the expected behavior?
  • the data coming from the API should have the following structure
    {
    "user": {
    "score": 0,
    "features": {
    "Followers": 3,
    "Repos": 11,
    "Stars": 3,
    "Forks": 0,
    "Commits": 289,
    "Issues": 0,
    "Contributions": 0,
    "Organizations": 1
    }
    },
    "averageFellow": {
    "score": 0,
    "features": {
    "Commits": 892,
    "Followers": 54,
    "Repos": 43,
    "Stars": 26,
    "Forks": 9,
    "Organizations": 1,
    "Issues": 104,
    "Contributions": 86
    }
    }
    }

Compute average fellow stats, save data to pull for future calculations.

  • I'm submitting a ...

    • bug report
    • [X ] feature request
    • support request
  • What is the current behavior?
    We don't have a method that fulfills the methods aligned.

  • What is the expected behavior?
    Compute average for ALL features we use in our prediction model (see below), then saves into a file that we can full from until new batch is updated.
    'num_followers': INT, 'num_repos': INT, 'num_stars': INT, 'num_forks': INT, 'num_commits': INT, 'num_pull_requests': INT, 'num_issues': INT, 'num_organizations':INT. 'num_issues': INT, 'num_organizations': INT

  • What is the motivation / use case for changing the behavior?
    We are missing this functionality

  • Other information Needs to use data that we are requesting from web app user.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.