From f10d00eb376012124a943f9be7a4e1e4d2c90616 Mon Sep 17 00:00:00 2001 From: ba-talibe Date: Fri, 26 Apr 2024 15:47:01 +0200 Subject: [PATCH 1/3] updated readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d4b0a83..8a0b0bc 100644 --- a/README.md +++ b/README.md @@ -12,17 +12,17 @@ Resources: For usage : ``` -pip install git+https://gitlab.insa-rouen.fr/msesboue/ontology-learning +pip install git+https://github.com/wikit-ai/olaf ``` For contribution : ``` -git clone https://gitlab.insa-rouen.fr/msesboue/ontology-learning.git -cd ontology-learning +git clone https://github.com/wikit-ai/olaf.git +cd olaf python3 -m venv ./venv -source venv/bin/active +source venv/bin/activate pip install . ``` From a2e85173f0987827232336bc74344e32654bf5d0 Mon Sep 17 00:00:00 2001 From: ba-talibe Date: Tue, 28 May 2024 16:01:44 +0200 Subject: [PATCH 2/3] updated the dev note --- docs/dev_notes.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/dev_notes.md b/docs/dev_notes.md index 14f4e4f..e0ebbf0 100644 --- a/docs/dev_notes.md +++ b/docs/dev_notes.md @@ -281,8 +281,11 @@ Generate documentation : - generate sphinx markdown `sphinx-apidocs -o docs olaf/` - and then generate html pages `cd docs && make html` -Update documentation hosted with github-pages : - -- move to gh-pages `git checkout gh-pages` -- rebase gh-pages to the main `git rebase main` -- and then push `git push origin gh-pages` +To host the documentation with with github-pages : + +- create a branch named `gh-pages` +- enable github pages and set the working branch as `gh-pages` +- create an acces-token +- add an environment secret named `TOKEN` with the generated acces token as value +- add an environment variable called `USER_MAIL` with your email address as value +- add an environment variable called `USER_NAME` with your github username as value \ No newline at end of file From 429213c54da01e53090be8bb65fc56ccf8079571 Mon Sep 17 00:00:00 2001 From: ba-talibe Date: Tue, 28 May 2024 17:29:14 +0200 Subject: [PATCH 3/3] added documentation link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a0b0bc..929215f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Since the beginning of the century, research on ontology learning has gained popularity. Automatically extracting and structuring knowledge relevant to a domain of interest from unstructured data is a major scientific challenge. We propose a new approach with modular ontology learning framework considering tasks from data pre-processing to axiom extraction. Whereas previous contributions considered ontology learning systems as tools to help the domain expert, we developed the proposed framework with full automation in mind. Resources: - +- The documentation is available here: [OLAF](https://wikit-ai.github.io/olaf/index.html) - [Poster](./docs/Poster_OLAF_2023.pdf) - Our research paper has been published at [KES 2023](http://kes2023.kesinternational.org/).