Giter VIP home page Giter VIP logo

pykitzoid's Introduction

Hacktoberfest 2023 with IEEE-VIT ๐Ÿ’™

This is a repository containing a Python package coded in Go, with the motive of providing ML support.

Support open source software by participating in Hacktoberfest and get goodies and digital badges! ๐Ÿ’™

Please check all issues labelled as hacktoberfest to start contributing!

Kindly consider leaving a โญ if you like the repository and our organisation.

Getting Started

  • Fork it.

  • Clone your forked repo and move inside it:

git clone https://github.com/IEEE-VIT/pykitzoid.git && cd pykitzoid

  • Checkout to a new branch to work on an issue:

git checkout -b my-amazing-feature

  • Get started working!

  • Once you're all done coding, it's time to open a PR :) Run the following commands from the root of the project directory:

git add .

git commit -m "A short description about the feature."

git push origin <my-amazing-feature>

Open your forked repo in your browser and then raise a PR to the main branch of this repository!

Contributing

To start contributing, check out CONTRIBUTING.md. New contributors are always welcome to support this project. If you want something gentle to start with, check out issues labelled easy or good-first-issue. Check out issues labelled hacktoberfest if you are up for some fun hacktoberfest goodies! :)

License

See the LICENSE file for license rights and limitations (MIT).

pykitzoid's People

Contributors

aanirudh07 avatar ananya190 avatar georgettica avatar griffinannshual avatar hariprasad19036 avatar harsh-avinash avatar imbeshat avatar kitrak-rev avatar meenuyd avatar ravin-d-27 avatar rohithparahmesh avatar varun10sudhir avatar verma-divyanshu-git avatar vessaldaneshvar avatar z404 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

pykitzoid's Issues

add: calc_weights function in Polynomial Regression Algorithm

Insert the code in the calc_weights function in pykitzoid/algorithms/polynomial_regression.go. This algorithm should aim at minimising the sum of squared differences between the predicted values (based on the line) and the actual Y values in the dataset.

add: issue templates

add the feature report and bug report using the following folder structure:
pykitzoid/.github/ISSUE_TEMPLATE/feature_report.md and
pykitzoid/.github/ISSUE_TEMPLATE/bug_report.md

add: demo python script

Add a demo Python script that will call on a Go function, helloWorld from pykitzoid/demo/library.go. The script should be saved as follows: pykitzoid/demo/demo_app.py.

Refer here

Note that helloWorld from library.go does not take any parameters.

add: predict_y function in Polynomial Regression Algorithm

Insert the code in the predict_y function in pykitzoid/algorithms/polynomial_regression.go. This algorithm should aim at predicting value of the dependent variable (Y) based on the given independent variable (X) and the polynomial regression model's coefficients.

add: sample go program

add a sample Go program, pykitzoid/demo/library.go containing a function that can be called by a Python script to the project as follows:

package main

import (
   "C"
   "log"
)

//export helloWorld
func helloWorld(){
   log.Println("Hello World")
}

func main(){

}

Refer here for more information.

add: mean function in linear regression algorithm

insert code in the mean function in pykitzoid/algorithms/linear_regression.go. bear in mind the format in which the dataset will be received (csv) and change the parameters and return types as you require. refer here

add : template for polynomial regression algorithm

Add a file saved as pykitzoid/algorithms/polynomial regression/ polynomial_regression.go that has the template for writing a polynomial regression algorithm. Refer to PR #10 for an example of how the template should look like . Refer here and here for an idea on how the algorithm should like

Add : read_csv function

Add the read_csv function in the pykitzoid/algorithms/polynomial Regression/ polynomial_regression.go. the file already contains necessary information needed to write the code. incase you have any doubts feel free to ask away

add: Makefile for easier and uniform build instructions

Add a Makefile to the repository, with commands that assist in building golang files into C shared object files, and to build source into a python package.

The following commands would be required:

  • dist : Creates a distributable of the python package using pyproject.toml as described here

  • binaries : Compiles all golang code into binaries and places them in thier respective directories

  • all : Builds binaries and compiles code into a python package (equivalent of running make binaries and then make dist)

  • clear : removes all build files (including binaries and distributable files)

add: basic python package directory setup

TODO:
Use this website to create a basic Python package's directory structure. Leave the pyproject.toml file empty. Don't create the README.md or LICENSE as they have already been created.

Expected folder structure:

Screen Shot 2022-10-01 at 2 30 13 AM

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.