Skip to content

Commit

Permalink
Add docu maybe
Browse files Browse the repository at this point in the history
  • Loading branch information
giopaglia committed Jul 9, 2024
1 parent 32030c8 commit 3a41ae4
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 2 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/Documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Documentation
on:
push:
branches:
- main
- dev
tags: '*'
pull_request:

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@latest
with:
version: '1.9'
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
run: julia --project=docs/ docs/make.jl
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Although at an embryonic stage, *Sole.jl* covers a relatively wide range of func
+ Algorithms for [model checking](https://en.wikipedia.org/wiki/Model_checking) (that is, checking that a formula is satisfied by an interpretation).
+ [*SoleData.jl*](https://github.com/aclai-lab/SoleData.jl) provides the **data layer** for representing *logisets*, that is, the logical counterpart to machine learning datasets:
+ Optimized data structures, useful when learning models from datasets;
+ Support for [multimodal data](https://en.m.wikipedia.org/wiki/Multimodal_learning).
+ Support for [multimodal data](https://en.wikipedia.org/wiki/Multimodal_learning).
+ [*SoleModels.jl*](https://github.com/aclai-lab/SoleModels.jl) defines the building blocks of **symbolic modeling**, featuring:
+ Definitions for (logic-agnostic) symbolic models (mainly, decision rules/lists/trees/forests);
+ Support for mixed, neuro-symbolic computation.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ CurrentModule = Sole

# Sole

Welcome to the documentation for [Sole](https://github.com/aclai-lab/Sole.jl).
Welcome to the documentation for [Sole](https://github.com/aclai-lab/Sole.jl), a Julia package for [symbolic AI](https://en.wikipedia.org/wiki/Symbolic_artificial_intelligence).

```@index
```
Expand Down

0 comments on commit 3a41ae4

Please sign in to comment.