An open API service indexing awesome lists of open source software.

https://github.com/jpcadena/linear-regression-course

Linear Regression Course.
https://github.com/jpcadena/linear-regression-course

Last synced: about 1 month ago
JSON representation

Linear Regression Course.

Awesome Lists containing this project

README

          

# linear-regression-course





Logo

Linear Regression Course


Description for Linear Regression Course


Explore the docs »



Table of Contents



  1. About The Project



  2. Getting Started


  3. Usage

  4. Contributing

  5. License

  6. Contact

## About the project

[![Project][project-screenshot]](https://example.com)

This project is about Linear Regression...

(back to top)

### Built with

* [![Python][Python.org]][Python-url]

(back to top)

## Getting started

* [Python 3.10+][Python-url]

### Installation

1. Clone the **repository**
```
git clone https://github.com/jpcadena/linear-regression-course.git
```
2. Change the directory to **root project**
```
cd linear-regression-course
```
3. Create a **virtual environment** *venv*
```
python3 -m venv venv
```
4. Activate **environment** in Windows
```
.\venv\Scripts\activate
```
5. Or with Unix/Mac OS X
```
source venv/bin/activate
```
6. Install requirements with PIP
```
pip install -r requirements.txt
```

(back to top)

### Usage

1. If found **sample.env**, rename it with to **.env**.
2. Replace your **credentials** into the *.env* file.
3. Execute with console
```
python main.py
```

(back to top)

## Contributing

If you have a suggestion that would make this better, please fork the repo and
create a pull request.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

Use docstrings with **reStructuredText** format by adding triple double quotes
**"""** after function definition.\
Add a brief function description, also for the parameters including the return
value and its corresponding data type.\
Please use **linting** to check your code quality
following [PEP 8](https://peps.python.org/pep-0008/).\
Check documentation
for [Visual Studio Code](https://code.visualstudio.com/docs/python/linting#_run-linting)
or [Jetbrains Pycharm](https://github.com/leinardi/pylint-pycharm/blob/master/README.md).\
Recommended plugin for
autocompletion: [Tabnine](https://www.tabnine.com/install)

(back to top)

## License

Distributed under the MIT License.

(back to top)

## Contact

LinkedIn: [Juan Pablo Cadena Aguilar][linkedin-url]

E-mail: [Juan Pablo Cadena Aguilar](mailto:jpcadena@espol.edu.ec?subject=[GitHub]linear-regression-course)

(back to top)

[linkedin-url]: https://linkedin.com/in/juanpablocadenaaguilar

[project-screenshot]: assets/images/project.png

[Python.org]: https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54

[Python-url]: https://www.python.org/