Skip to content

Commit 1752674

Browse files
committed
Initial commit (v1)
1 parent 7dc2269 commit 1752674

File tree

1 file changed

+8
-57
lines changed

1 file changed

+8
-57
lines changed

README.md

Lines changed: 8 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<a href="https://genular.org" target="_blank">
44
<img width="200" src="https://github.com/genular/pandora/raw/master/.github/static/favicon.png"></a>
55
</p>
6-
<h1>PANDORA<br/><sub>machine learning feature discovery platform</sub></h1>
6+
<h1>PANDORA<br/><sub>uncover hidden insights and patterns from complex data</sub></h1>
77
<p align="center">
88
<a href="https://crowdin.com/project/genular" alt="Help us translate">
99
<img src="https://d322cqt584bo4o.cloudfront.net/genular/localized.svg" /></a>
@@ -18,80 +18,44 @@
1818

1919
## Intro
2020

21-
`PANDORA` is a powerful, flexible, open-source and easy to use Data Science Knowledge Discovery software.
22-
Currently `PANDORA` implements Machine Learning and many other statistical data discovery features ([Hierarchical clustering](https://en.wikipedia.org/wiki/Hierarchical_clustering), [Correlation](https://en.wikipedia.org/wiki/Correlation_and_dependence), [PCA Analysis](https://en.wikipedia.org/wiki/Principal_component_analysis), [UMAP](https://en.wikipedia.org/wiki/Nonlinear_dimensionality_reduction), [t-SNE](https://en.wikipedia.org/wiki/T-distributed_stochastic_neighbor_embedding) and others) that will help you to illustrate dynamic relationships and provide you with a structural sense of your data.
23-
24-
## Why is this so cool?
25-
26-
- :file_folder: **feature discovery** you can discover relevant trends and patterns inside your data with ease, that would usually take years of manual handcrafting
27-
- :chart: **machine learning** Build Machine Learning models with ease, and quickly compare them via our innovative interface
28-
- :package: **exploratory data analysis** visual analysis of multiple different machine learning results will give you instant insights with help of many different visualization algorithms
29-
- :arrows_counterclockwise: **sharing is caring** you can share your results with others, deploy your models instantly\* \*(in progress)\_ or download your data for external use
30-
- :closed_lock_with_key: **privacy and security** hosting `PANDORA` on your own dedicated servers or laptop you don't have to worry about someone else is looking after your data and your models
31-
32-
## Current version features
21+
`PANDORA` is a modular open-source software that facilitates data analysis and knowledge discovery in biology and medicine. It is designed to empower non-technical and technical researchers to identify crucial patterns in biomedical data by providing an easy-to-use graphical user interface and standardized pipelines. It offers more than 200 machine-learning algorithms to choose from, including hierarchical clustering, correlation, PCA analysis, UMAP, t-SNE, and others. The software also features a drag-and-drop user interface, support for high-sparsity data, local and cloud data storage, built-in data preprocessing, and a variety of visualization algorithms for exploratory data analysis.
3322

3423
<img alt="PANDORA UI screenshot" src=".github/static/pandora_analysis.png" align="right" width="500px"/>
3524

36-
- **200+** machine learning algorithms to <a href="https://topepo.github.io/caret/available-models.html" target="_blank">choose from</a>
37-
- nicely designed **drag&drop** user interface to easily apply _data modeling techniques_
38-
- supports **high sparsity** data via data imputation or <a href="https://cran.r-project.org/web/packages/mulset/index.html" target="_blank" title="Multiset Intersection Generator">mulset</a>
39-
- supports **local** and **cloud** backend data storage
40-
- compare all **model performance measures** in one place
41-
- visual **data analysis** that supports _clustering_ and _correlation graphs_
42-
- visual **feature analysis** with dot-plots that supports **280 visual styles**
43-
- visual **model performance comparison** and **model insights**
44-
- in-build **data preprocessing** (correlation filtering, normalization, imputation...)
45-
- public dataset repository import to **easily import** and **analyze** already published data\* _(in progress)_
46-
- integrated **SAM (Significance Analysis of Microarrays)** technique for finding significant genes in a set of microarray experiments
47-
- **multi-language** localization support
48-
- **model & data export** take your ML models and other performed analysis, reproducibility code and associated data with you on the go\* _(in progress)_
49-
50-
---
51-
5225
## Installation Quick-start
5326

5427
### Easy
5528

56-
This section describes the process of pulling a pre-built version of `PANDORA` from [DockerHub](https://hub.docker.com/).
57-
If you are beginner or you wish to quickly check it out this is recommended way to start `PANDORA`. This can also be very handy for developers for development without polluting the host machine.
58-
The `PANDORA` source code includes a [Dockerfile](https://github.com/genular/pandora-backend/blob/master/documentation/docker_images/Dockerfile).
29+
`PANDORA` can be easily installed using Docker, a pre-built version of the software can be pulled from [DockerHub](https://hub.docker.com/). In order to run a test instance of PANDORA, users will first need to prepare their local environment by downloading, installing and configuring [Docker](https://www.docker.com/).
5930

6031
#### Requirements
6132

6233
##### Software:
6334

35+
- Windows, Linux or MacOS
6436
- [Docker](https://docs.docker.com/engine/installation/) (`version 17.05` or later is required)
6537

66-
##### Minimum hardware recommendation:
38+
##### Minimum suggested hardware recommendation:
6739

6840
- 64GB RAM
6941
- 8 CPU Cores / 16 threads with 3.60 GHz base frequency
7042

71-
#### Running PANDORA Docker Container
72-
73-
In order to run a test instance of `PANDORA` we first need to prepare the local environment.
74-
75-
1. Download and install [Docker](https://docker.com). When you finished installing [Docker](https://docs.docker.com/engine/installation/) please _continue_ to steps below.
76-
77-
2. Lets download and run the `genular/pandora` image from DockerHub:
43+
#### Running PANDORA
7844

7945
- Please **open** your favorite **Terminal** and **run** the **command below**. If on Windows - open `Windows Power Shell` => _Click Start, type PowerShell, and then click Windows PowerShel_
8046

81-
> _If you wish to get correct time inside PANDORA, replace TZ=<timzone> variable with your timezone. You can find list of supported timezones [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)_
82-
8347
```bash
8448
docker run --rm --detach --name genular --tty --interactive --env IS_DOCKER='true' --env TZ=Europe/London --oom-kill-disable --volume genular_data_latest:/mnt/usrdata --publish 3010:3010 --publish 3011:3011 --publish 3012:3012 --publish 3013:3013 genular/pandora:latest
8549

8650
```
8751

88-
3. Once command is executed and the `PANDORA` is downloaded and started you can access it on `http://localhost:3010` via your web favorite browser _(we recommend [Firefox](https://www.mozilla.org/en-GB/firefox/new/))_ and create your administrator account.
52+
`PANDORA` will be downloaded and started, and it can be accessed via a web browser at [http://localhost:3010](http://localhost:3010)
8953

9054
- If you get asked, please _allow connections_ through your _Windows Firewall_.
9155

9256
#### Reinstalling PANDORA
9357

94-
In order to re-install `PANDORA` you need to delete previously installed `PANDORA` Docker container and associate data/volumes. More info about that on ,<a href ="https://docs.docker.com/config/pruning/" target="_blank">official Docker documentation.</a> Be sure to stop currently running container (if any). To delete all Docker Images, Containers, Volumes, and Networks execute following:
58+
To reinstall PANDORA, users will need to delete the previously installed PANDORA Docker container and associated data/volumes by stopping the currently running container:
9559

9660
```bash
9761
docker stop genular
@@ -118,19 +82,6 @@ If you need any help, please use [community forums](https://community.genular.or
11882
[3]: https://help.github.com/articles/fork-a-repo/
11983
[4]: https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches
12084

121-
### Places to Help
122-
123-
We're looking for contributors!
124-
In addition to contributing, optimizing and reviewing code, writing bug and feature requests you can help with following:
125-
126-
| Project | How To Help | Next Step |
127-
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
128-
| Localization | Help us translate `PANDORA` into your language. If some translation is missing or incorrect you can easily help us by correcting it. | [Join our Translation Community](https://crowdin.com/project/genular) |
129-
| Tutorials | Help others use and understand `PANDORA` | Write a tutorial or record it, with usage examples |
130-
| Organizing | Ask clarifying questions on recently opened GitHub issues to move the discussion forward | [Here](https://github.com/genular/pandora/issues) |
131-
| Write article | Help others understand what is Machine Learning & how can they apply it, by publishing blog post | [e-mail us](mailto:info@genular.com) |
132-
133-
13485
### Reaching Out
13586

13687
If you'd like to start a conversation feel free to [e-mail us](mailto:info@genular.com).

0 commit comments

Comments
 (0)