Skip to content

Commit

Permalink
Merge pull request chekoduadarsh#88 from QazCetelic/main
Browse files Browse the repository at this point in the history
Small improvements to README
  • Loading branch information
chekoduadarsh authored Mar 23, 2022
2 parents 980ae05 + 34126f6 commit 35ed305
Showing 1 changed file with 18 additions and 19 deletions.
37 changes: 18 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img src="https://raw.githubusercontent.com/chekoduadarsh/BlocklyML/main/media/blocklyML_Banner.png">
![](https://raw.githubusercontent.com/chekoduadarsh/BlocklyML/main/media/blocklyML_Banner.png)

<h1 style="text-align: center;"><a href="https://blocklyml.herokuapp.com/ ">Blockly ML</a></h1>

Expand All @@ -7,8 +7,7 @@
![](https://img.shields.io/github/issues/chekoduadarsh/BlocklyML)
![](https://img.shields.io/github/last-commit/chekoduadarsh/BlocklyML)


<a href="https://blocklyml.herokuapp.com/"> https://blocklyml.herokuapp.com/ </a>
![blocklyml.herokuapp.com](https://blocklyml.herokuapp.com/)

### What is BlocklyML?
BlocklyML is a **No Code** training ground for python and Machine Learning. This tool is designed to simplify standard machine learning implementation.
Expand All @@ -17,7 +16,7 @@ This tool can assist anyone who wants to start with Machine Learning or python.
For a sample run go to sampleLayouts folder upload and try it out :smiley:


Read the <a href="https://github.com/chekoduadarsh/BlocklyML/blob/main/UserGuide.md"> UserGuide.md</a> for further info
Read the ![UserGuide.md](https://github.com/chekoduadarsh/BlocklyML/blob/main/UserGuide.md) for further info


In the Example given below we will train a random forest for Iris Dataset
Expand All @@ -26,38 +25,38 @@ In the Example given below we will train a random forest for Iris Dataset

# Table of contents

* <a href="https://github.com/chekoduadarsh/BlocklyML/blob/main/README.md#blocklyml"> Project Title</a>
* <a href="https://github.com/chekoduadarsh/BlocklyML/blob/main/README.md#installing-as-blocklyml-app"> Installlation</a>
* <a href="https://github.com/chekoduadarsh/BlocklyML/blob/main/README.md#ui-features"> UI Features</a>
* <a href="https://github.com/chekoduadarsh/BlocklyML/blob/main/README.md#shortcuts"> Shortcuts</a>
* <a href="https://github.com/chekoduadarsh/BlocklyML/blob/main/README.md#dataframe-viewer"> Dataframe Viewer</a>
* <a href="https://github.com/chekoduadarsh/BlocklyML/blob/main/README.md#download-code"> Download Code</a>
* <a href="https://github.com/chekoduadarsh/BlocklyML/blob/main/README.md#contribute"> Contribute</a>
* <a href="https://github.com/chekoduadarsh/BlocklyML/blob/main/README.md#license"> License</a>
* [Project Title](#blocklyml)
* [Installlation](#installing-as-blocklyml-app)
* [UI Features](#ui-features)
* [Shortcuts](#shortcuts)
* [Dataframe Viewer](#dataframe-viewer)
* [Download Code](#download-code)
* [Contribute](#contribute)
* [License](#license)
# Installing as BlocklyML App
First clone this repo

```
```shell
git clone https://github.com/chekoduadarsh/BlocklyML
```
After cloning the repo you can either follow the Docker Method or Flask Method

### Docker Method
BlocklyML can run on Docker with the following command :cd:

```
```shell
docker run blocklyml-docker
```
### Flask Method

Install the requirements from requirements.txt with the following command
Install the requirements from `requirements.txt` with the following command

```
```shell
pip install -r requirements.txt
```

then you can run the application by
```
```shell
python app.py
```

Expand Down Expand Up @@ -96,11 +95,11 @@ If you find any error or need support please raise a issue. If you think you can

Feel free to adapt it criticize it and support it the way you like!!

Read : <a href="https://github.com/ThioJoe/YT-Spammer-Purge/blob/main/CONTRIBUTING.md">CONTRIBUTING.md</a>
Read : [CONTRIBUTING.md](./CONTRIBUTING.md)


# License
<a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>
[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)



Expand Down

0 comments on commit 35ed305

Please sign in to comment.