obsei commited on
Commit
35bfee9
β€’
1 Parent(s): 9b24016

Adding more info to Readme

Browse files
Files changed (1) hide show
  1. README.md +106 -16
README.md CHANGED
@@ -9,19 +9,109 @@ app_file: app.py
9
  pinned: false
10
  ---
11
 
12
- # Configuration
13
- `title`: _string_
14
- Display title for the Space
15
- `emoji`: _string_
16
- Space emoji (emoji-only character allowed)
17
- `colorFrom`: _string_
18
- Color for Thumbnail gradient (red, yellow, green, blue, indigo, purple, pink, gray)
19
- `colorTo`: _string_
20
- Color for Thumbnail gradient (red, yellow, green, blue, indigo, purple, pink, gray)
21
- `sdk`: _string_
22
- Can be either `gradio` or `streamlit`
23
- `app_file`: _string_
24
- Path to your main application file (which contains either `gradio` or `streamlit` Python code).
25
- Path is relative to the root of the repository.
26
- `pinned`: _boolean_
27
- Whether the Space stays on top of your list.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  pinned: false
10
  ---
11
 
12
+ <p align="center">
13
+ <img src="https://raw.githubusercontent.com/obsei/obsei-resources/master/images/obsei-flyer.png" />
14
+ </p>
15
+
16
+ <p align="center">
17
+ <a href="https://github.com/obsei/obsei/blob/master/LICENSE">
18
+ <img alt="License" src="https://img.shields.io/pypi/l/obsei">
19
+ </a>
20
+ <a href="https://github.com/obsei/obsei">
21
+ <img alt="Github stars" src="https://img.shields.io/github/stars/obsei/obsei?style=social">
22
+ </a>
23
+ </p>
24
+
25
+ **Obsei** is an open-source low-code AI powered automation tool. *Obsei* consist of -
26
+ - **Observer**, observes platform like Twitter, Facebook, App Stores, Google reviews, Amazon reviews, News, Website etc and feed that information to,
27
+ - **Analyzer**, which perform text analysis like classification, sentiment, translation, PII etc and feed that information to,
28
+ - **Informer**, which send it to ticketing system, data store, dataframe etc for further action and analysis.
29
+
30
+
31
+ ![](https://raw.githubusercontent.com/obsei/obsei-resources/master/gifs/obsei_flow.gif)
32
+
33
+ ## Documentation
34
+ For detailed installation instructions, usages and example refer [documentation](https://obsei.github.io/obsei/).
35
+
36
+ ## Tutorials
37
+
38
+ <table>
39
+ <thead>
40
+ <tr class="header">
41
+ <th>Sr. No.</th>
42
+ <th>Workflow</th>
43
+ <th>Colab</th>
44
+ <th>Binder</th>
45
+ </tr>
46
+ </thead>
47
+ <tbody>
48
+ <tr>
49
+ <td rowspan="2">1</td>
50
+ <td colspan="3">Observe app reviews from Google play store, Analyze them via performing text classification and then Inform them on console via logger</td>
51
+ </tr>
52
+ <tr>
53
+ <td>PlayStore Reviews β†’ Classification β†’ Logger</td>
54
+ <td>
55
+ <a href="https://colab.research.google.com/github/obsei/obsei/blob/master/tutorials/01_PlayStore_Classification_Logger.ipynb">
56
+ <img alt="Colab" src="https://colab.research.google.com/assets/colab-badge.svg">
57
+ </a>
58
+ </td>
59
+ <td>
60
+ <a href="https://mybinder.org/v2/gh/obsei/obsei/HEAD?filepath=tutorials%2F01_PlayStore_Classification_Logger.ipynb">
61
+ <img alt="Colab" src="https://mybinder.org/badge_logo.svg">
62
+ </a>
63
+ </td>
64
+ </tr>
65
+ <tr>
66
+ <td rowspan="2">2</td>
67
+ <td colspan="3">Observe app reviews from Google play store, PreProcess text via various text cleaning function, Analyze them via performing text classification, Inform them to Pandas DataFrame and store resultant CSV to Google Drive</td>
68
+ </tr>
69
+ <tr>
70
+ <td>PlayStore Reviews β†’ PreProcessing β†’ Classification β†’ Pandas DataFrame β†’ CSV in Google Drive</td>
71
+ <td>
72
+ <a href="https://colab.research.google.com/github/obsei/obsei/blob/master/tutorials/02_PlayStore_PreProc_Classification_Pandas.ipynb">
73
+ <img alt="Colab" src="https://colab.research.google.com/assets/colab-badge.svg">
74
+ </a>
75
+ </td>
76
+ <td>
77
+ <a href="https://mybinder.org/v2/gh/obsei/obsei/HEAD?filepath=tutorials%2F02_PlayStore_PreProc_Classification_Pandas.ipynb">
78
+ <img alt="Colab" src="https://mybinder.org/badge_logo.svg">
79
+ </a>
80
+ </td>
81
+ </tr>
82
+ <tr>
83
+ <td rowspan="2">3</td>
84
+ <td colspan="3">Observe app reviews from Apple app store, PreProcess text via various text cleaning function, Analyze them via performing text classification, Inform them to Pandas DataFrame and store resultant CSV to Google Drive</td>
85
+ </tr>
86
+ <tr>
87
+ <td>AppStore Reviews β†’ PreProcessing β†’ Classification β†’ Pandas DataFrame β†’ CSV in Google Drive</td>
88
+ <td>
89
+ <a href="https://colab.research.google.com/github/obsei/obsei/blob/master/tutorials/03_AppStore_PreProc_Classification_Pandas.ipynb">
90
+ <img alt="Colab" src="https://colab.research.google.com/assets/colab-badge.svg">
91
+ </a>
92
+ </td>
93
+ <td>
94
+ <a href="https://mybinder.org/v2/gh/obsei/obsei/HEAD?filepath=tutorials%2F03_AppStore_PreProc_Classification_Pandas.ipynb">
95
+ <img alt="Colab" src="https://mybinder.org/badge_logo.svg">
96
+ </a>
97
+ </td>
98
+ </tr>
99
+ <tr>
100
+ <td rowspan="2">4</td>
101
+ <td colspan="3">Observe news article from Google news, PreProcess text via various text cleaning function, Analyze them via performing text classification while splitting text in small chunks and later computing final inference using given formula</td>
102
+ </tr>
103
+ <tr>
104
+ <td>Google News β†’ Text Cleaner β†’ Text Splitter β†’ Classification β†’ Inference Aggregator</td>
105
+ <td>
106
+ <a href="https://colab.research.google.com/github/obsei/obsei/blob/master/tutorials/04_GoogleNews_Cleaner_Splitter_Classification_Aggregator.ipynb">
107
+ <img alt="Colab" src="https://colab.research.google.com/assets/colab-badge.svg">
108
+ </a>
109
+ </td>
110
+ <td>
111
+ <a href="https://mybinder.org/v2/gh/obsei/obsei/HEAD?filepath=tutorials%2F04_GoogleNews_Cleaner_Splitter_Classification_Aggregator.ipynb">
112
+ <img alt="Colab" src="https://mybinder.org/badge_logo.svg">
113
+ </a>
114
+ </td>
115
+ </tr>
116
+ </tbody>
117
+ </table>