diff --git a/.github/workflows/build-and-test.yaml b/.github/workflows/build-and-test.yaml index 5e986fc..55be899 100644 --- a/.github/workflows/build-and-test.yaml +++ b/.github/workflows/build-and-test.yaml @@ -1,4 +1,4 @@ -name: ABLKit-CI +name: ABLkit-CI on: push: diff --git a/README.md b/README.md index 24c95bc..35a41fd 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@

-ABLKit logo +ABLkit logo


[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ablkit)](https://pypi.org/project/ablkit/) [![PyPI version](https://badgen.net/pypi/v/ablkit)](https://pypi.org/project/ablkit/) [![Documentation Status](https://readthedocs.org/projects/ablkit/badge/?version=latest)](https://ablkit.readthedocs.io/en/latest/?badge=latest) -[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://github.com/AbductiveLearning/ABLKit/blob/main/LICENSE) -[![flake8 Lint](https://github.com/AbductiveLearning/ABLKit/actions/workflows/lint.yaml/badge.svg)](https://github.com/AbductiveLearning/ABLKit/actions/workflows/lint.yaml) +[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://github.com/AbductiveLearning/ABLkit/blob/main/LICENSE) +[![flake8 Lint](https://github.com/AbductiveLearning/ABLkit/actions/workflows/lint.yaml/badge.svg)](https://github.com/AbductiveLearning/ABLkit/actions/workflows/lint.yaml) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -[![ABLKit-CI](https://github.com/AbductiveLearning/ABLKit/actions/workflows/build-and-test.yaml/badge.svg)](https://github.com/AbductiveLearning/ABLKit/actions/workflows/build-and-test.yaml) +[![ABLkit-CI](https://github.com/AbductiveLearning/ABLkit/actions/workflows/build-and-test.yaml/badge.svg)](https://github.com/AbductiveLearning/ABLkit/actions/workflows/build-and-test.yaml) [📘Documentation](https://ablkit.readthedocs.io/en/latest/index.html) | -[📚Examples](https://github.com/AbductiveLearning/ABLKit/tree/main/examples) | -[💬Reporting Issues](https://github.com/AbductiveLearning/ABLKit/issues/new) +[📚Examples](https://github.com/AbductiveLearning/ABLkit/tree/main/examples) | +[💬Reporting Issues](https://github.com/AbductiveLearning/ABLkit/issues/new)
@@ -41,7 +41,7 @@ an efficient and convenient toolkit to develop dual-driven ABL systems, which leverage the power of both data and knowledge.

-ABL kit +ABL kit

## Installation @@ -59,8 +59,8 @@ pip install ablkit Alternatively, to install from source code, sequentially run following commands in your terminal/command line. ```bash -git clone https://github.com/AbductiveLearning/ABLKit.git -cd ABLKit +git clone https://github.com/AbductiveLearning/ABLkit.git +cd ABLkit pip install -v -e . ``` @@ -205,10 +205,10 @@ To explore detailed tutorials and information, please refer to - [document](http We provide several examples in `examples/`. Each example is stored in a separate folder containing a README file. -+ [MNIST Addition](https://github.com/AbductiveLearning/ABLKit/tree/main/examples/mnist_add) -+ [Handwritten Formula (HWF)](https://github.com/AbductiveLearning/ABLKit/tree/main/examples/hwf) -+ [Handwritten Equation Decipherment](https://github.com/AbductiveLearning/ABLKit/tree/main/examples/hed) -+ [Zoo](https://github.com/AbductiveLearning/ABLKit/tree/main/examples/zoo) ++ [MNIST Addition](https://github.com/AbductiveLearning/ABLkit/tree/main/examples/mnist_add) ++ [Handwritten Formula (HWF)](https://github.com/AbductiveLearning/ABLkit/tree/main/examples/hwf) ++ [Handwritten Equation Decipherment](https://github.com/AbductiveLearning/ABLkit/tree/main/examples/hed) ++ [Zoo](https://github.com/AbductiveLearning/ABLkit/tree/main/examples/zoo) ## References diff --git a/docs/Examples/HED.rst b/docs/Examples/HED.rst index 962c0cd..d8fbed0 100644 --- a/docs/Examples/HED.rst +++ b/docs/Examples/HED.rst @@ -3,7 +3,7 @@ Handwritten Equation Decipherment (HED) .. raw:: html -

For detailed code implementation, please view it on GitHub.

+

For detailed code implementation, please view it on GitHub.

Below shows an implementation of `Handwritten Equation Decipherment `__. diff --git a/docs/Examples/HWF.rst b/docs/Examples/HWF.rst index 40d1b16..75616c5 100644 --- a/docs/Examples/HWF.rst +++ b/docs/Examples/HWF.rst @@ -3,7 +3,7 @@ Handwritten Formula (HWF) .. raw:: html -

For detailed code implementation, please view it on GitHub.

+

For detailed code implementation, please view it on GitHub.

Below shows an implementation of `Handwritten Formula `__. In this diff --git a/docs/Examples/MNISTAdd.rst b/docs/Examples/MNISTAdd.rst index f652df2..3127139 100644 --- a/docs/Examples/MNISTAdd.rst +++ b/docs/Examples/MNISTAdd.rst @@ -3,7 +3,7 @@ MNIST Addition .. raw:: html -

For detailed code implementation, please view it on GitHub.

+

For detailed code implementation, please view it on GitHub.

Below shows an implementation of `MNIST Addition `__. In this task, pairs of diff --git a/docs/Examples/Zoo.rst b/docs/Examples/Zoo.rst index be33664..33b54ec 100644 --- a/docs/Examples/Zoo.rst +++ b/docs/Examples/Zoo.rst @@ -3,7 +3,7 @@ Zoo .. raw:: html -

For detailed code implementation, please view it on GitHub.

+

For detailed code implementation, please view it on GitHub.

Below shows an implementation of `Zoo `__ dataset. In this task, diff --git a/docs/Overview/Installation.rst b/docs/Overview/Installation.rst index c9b26aa..123e1f7 100644 --- a/docs/Overview/Installation.rst +++ b/docs/Overview/Installation.rst @@ -18,8 +18,8 @@ sequentially run following commands in your terminal/command line. .. code:: bash - git clone https://github.com/AbductiveLearning/ABLKit.git - cd ABLKit + git clone https://github.com/AbductiveLearning/ABLkit.git + cd ABLkit pip install -v -e . (Optional) Install SWI-Prolog diff --git a/docs/README.rst b/docs/README.rst index 107677b..103885e 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -18,7 +18,7 @@ ABL kit encapsulates advanced ABL techniques, providing users with an efficient and convenient toolkit to develop dual-driven ABL systems, which leverage the power of both data and knowledge. -.. image:: _static/img/ABLKit.png +.. image:: _static/img/ABLkit.png Installation ------------ @@ -40,8 +40,8 @@ sequentially run following commands in your terminal/command line. .. code:: bash - git clone https://github.com/AbductiveLearning/ABLKit.git - cd ABLKit + git clone https://github.com/AbductiveLearning/ABLkit.git + cd ABLkit pip install -v -e . (Optional) Install SWI-Prolog diff --git a/pyproject.toml b/pyproject.toml index 86e2949..fcf9bd6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,8 +40,8 @@ dependencies = [ ] [project.urls] -Homepage = "https://github.com/AbductiveLearning/ABLKit" -Issues = "https://github.com/AbductiveLearning/ABLKit/issues" +Homepage = "https://github.com/AbductiveLearning/ABLkit" +Issues = "https://github.com/AbductiveLearning/ABLkit/issues" [project.optional-dependencies] test = [