Skip to content

Commit 4768c78

Browse files
authored
#283: Updated README and user guide (#284)
* #283: Updated description and README * Changed trigger for CI build to only push main * Fixed trigger
1 parent b71f5c9 commit 4768c78

File tree

4 files changed

+6
-5
lines changed

4 files changed

+6
-5
lines changed

.github/workflows/ci.yml

-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ on:
77
- "gh-pages/*"
88
- "main"
99
- "master"
10-
pull_request:
11-
types: [opened, reopened]
1210
schedule:
1311
# “At 00:00 on every 7th day-of-month from 1 through 31.” (https://crontab.guru)
1412
- cron: "0 0 1/7 * *"

README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Exasol Advanced Analytics Framework
22

3-
**This project is at an early development stage.**
4-
53
Framework for building complex data analysis algorithms with Exasol.
64

5+
This framework allows you to implement advanced analytics algorithms — like PageRank or K-Means — that run iteratively inside the Exasol database. It bridges the gap between Python (for data science logic) and Lua (for database-side execution control), enabling complex workflows to be run within a single transaction context.
76

87
## Information for Users
98

doc/changes/unreleased.md

+4
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
11
# Unreleased
2+
3+
## Documentation
4+
5+
* #283: Updated description and README

doc/user_guide/user_guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Advanced Analytics Framework User Guide
22

3-
The Advanced Analytics Framework (AAF) enables implementing complex data analysis algorithms with Exasol. Users can use the features of AAF in their custom implementations.
3+
The Advanced Analytics Framework (AAF) allows you to implement advanced analytics algorithms — like PageRank or K-Means — that run iteratively inside the Exasol database. It bridges the gap between Python (for data science logic) and Lua (for database-side execution control), enabling complex workflows to be run within a single transaction context.
44

55
AAF employs Lua scripts and User Defined Functions (UDFs). The Lua scripts are orchestrating the UDFs while the UDFs are performing the actual analytic functions.
66

0 commit comments

Comments
 (0)