Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Various readme improvements #93

Merged
merged 3 commits into from
Apr 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DIRECTORY.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
* [Association](https://github.com/TheAlgorithms/Jupyter/blob/master/machine_learning/Associative%20Mining/Association.ipynb)
* Basics Of Tensorflow
* [Basic Of Tensorflow](https://github.com/TheAlgorithms/Jupyter/blob/master/machine_learning/Basics%20of%20tensorflow/Basic%20of%20TensorFlow.ipynb)
* [Bayesian Belief Networks](https://github.com/TheAlgorithms/Jupyter/blob/master/machine_learning/bayesian_belief_networks.ipynb)
* Cosine-Similarity
* [Similarity](https://github.com/TheAlgorithms/Jupyter/blob/master/machine_learning/Cosine-Similarity/Similarity.ipynb)
* Dbscan
Expand Down Expand Up @@ -65,7 +66,6 @@
* [Scikit-Learn](https://github.com/TheAlgorithms/Jupyter/blob/master/machine_learning/Scikit-learn/Scikit-learn.ipynb)
* Support Vector Machine
* [Support Vector Machine](https://github.com/TheAlgorithms/Jupyter/blob/master/machine_learning/Support_Vector_Machine/Support%20Vector%20Machine.ipynb)
* [Bayesian Belief Network](./machine_learning/bayesian_belief_networks.ipynb)

## Neural Network
* [02-Imdb-Binary-Classification](https://github.com/TheAlgorithms/Jupyter/blob/master/neural_network/02-imdb-binary-classification.ipynb)
Expand Down
33 changes: 22 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,34 @@
## Jupyter ![](https://img.shields.io/github/forks/TheAlgorithms/Jupyter?style=social) ![](https://img.shields.io/github/stars/TheAlgorithms/Jupyter?style=social) ![](https://img.shields.io/github/watchers/TheAlgorithms/Jupyter?style=social) <br>

![](https://img.shields.io/github/repo-size/TheAlgorithms/Jupyter) ![](https://img.shields.io/github/downloads/TheAlgorithms/Jupyter/total) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/TheAlgorithms/Jupyter)<br>
![](https://img.shields.io/github/issues/TheAlgorithms/Jupyter?color=green) ![](https://img.shields.io/github/issues-pr/TheAlgorithms/Jupyter?color=green) ![](https://img.shields.io/github/last-commit/TheAlgorithms/Jupyter) ![](https://img.shields.io/github/contributors/TheAlgorithms/Jupyter)
## The Algorithms - Jupyter

![Repo size](https://img.shields.io/github/repo-size/TheAlgorithms/Jupyter)
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/TheAlgorithms/Jupyter)
![Number of issues](https://img.shields.io/github/issues/TheAlgorithms/Jupyter?color=green)
![Number of PRs](https://img.shields.io/github/issues-pr/TheAlgorithms/Jupyter?color=green)<br>
![Latest commit](https://img.shields.io/github/last-commit/TheAlgorithms/Jupyter)
![All contributors](https://img.shields.io/github/contributors/TheAlgorithms/Jupyter)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/TheAlgorithms/Jupyter/master)

## Clone git repository

```sh
$ git clone "https://github.com/TheAlgorithms/Jupyter.git"
```
## Getting started

You can run and edit the algorithms or contribute to them using [Gitpod.io](https://www.gitpod.io/), a free online development environment, with a single click.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](http://gitpod.io/#https://github.com/TheAlgorithms/Jupyter)

## Contributing New Algorithms

* Make your pull requests to be **specific** and **focused**. Instead of contributing "several algorithms" all at once contribute them all one by one separately (i.e. one pull request for "Logistic Regression", another one for "K-Means", and so on).

* Every new algorithm must have:
* **Source code** with comments and readable namings
* **Math** being explained in README.md along with the code
* **Jupyter demo notebook** with an example of how this new algorithm may be applied

If you're adding new **datasets** they need to be saved in the `/data` folder. CSV files are preferable. The size of the file should not be greater than `30Mb`.

## Contributing

Before removing any bug, or adding new algorithm please do the following: **[Check Contribution Guidelines Before Contribution](Contributing.md)** and also please read **[CODE OF CONDUCT](CODE_OF_CONDUCT.md)**.
Before removing any bug, or adding new algorithms please read our [Contribution Guidelines](Contributing.md)** and our **[Code of Conduct](CODE_OF_CONDUCT.md)**.

## License

Licensed under the [MIT License](LICENSE.md)
All the code is licensed under the [MIT License](LICENSE.md)