Browse Source

[MNT] change Kit to kit (cont.)

pull/6/head
troyyyyy 1 year ago
parent
commit
e86f9e04b2
9 changed files with 25 additions and 25 deletions
  1. +1
    -1
      .github/workflows/build-and-test.yaml
  2. +13
    -13
      README.md
  3. +1
    -1
      docs/Examples/HED.rst
  4. +1
    -1
      docs/Examples/HWF.rst
  5. +1
    -1
      docs/Examples/MNISTAdd.rst
  6. +1
    -1
      docs/Examples/Zoo.rst
  7. +2
    -2
      docs/Overview/Installation.rst
  8. +3
    -3
      docs/README.rst
  9. +2
    -2
      pyproject.toml

+ 1
- 1
.github/workflows/build-and-test.yaml View File

@@ -1,4 +1,4 @@
name: ABLKit-CI
name: ABLkit-CI

on:
push:


+ 13
- 13
README.md View File

@@ -1,21 +1,21 @@
<div align="center">

<p align="center">
<img src="./docs/_static/img/logo.png" alt="ABLKit logo" style="width: 35%;"/>
<img src="./docs/_static/img/logo.png" alt="ABLkit logo" style="width: 35%;"/>
</p>
<br>

[![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)

</div>

@@ -41,7 +41,7 @@ an efficient and convenient toolkit to develop dual-driven ABL systems,
which leverage the power of both data and knowledge.

<p align="center">
<img src="./docs/_static/img/ABLKit.png" alt="ABL kit" style="width: 80%;"/>
<img src="./docs/_static/img/ABLkit.png" alt="ABL kit" style="width: 80%;"/>
</p>

## 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



+ 1
- 1
docs/Examples/HED.rst View File

@@ -3,7 +3,7 @@ Handwritten Equation Decipherment (HED)

.. raw:: html
<p>For detailed code implementation, please view it on <a class="reference external" href="https://github.com/AbductiveLearning/ABLKit/tree/main/examples/hed" target="_blank">GitHub</a>.</p>
<p>For detailed code implementation, please view it on <a class="reference external" href="https://github.com/AbductiveLearning/ABLkit/tree/main/examples/hed" target="_blank">GitHub</a>.</p>

Below shows an implementation of `Handwritten Equation
Decipherment <https://proceedings.neurips.cc/paper_files/paper/2019/file/9c19a2aa1d84e04b0bd4bc888792bd1e-Paper.pdf>`__.


+ 1
- 1
docs/Examples/HWF.rst View File

@@ -3,7 +3,7 @@ Handwritten Formula (HWF)

.. raw:: html
<p>For detailed code implementation, please view it on <a class="reference external" href="https://github.com/AbductiveLearning/ABLKit/tree/main/examples/hwf" target="_blank">GitHub</a>.</p>
<p>For detailed code implementation, please view it on <a class="reference external" href="https://github.com/AbductiveLearning/ABLkit/tree/main/examples/hwf" target="_blank">GitHub</a>.</p>

Below shows an implementation of `Handwritten
Formula <https://arxiv.org/abs/2006.06649>`__. In this


+ 1
- 1
docs/Examples/MNISTAdd.rst View File

@@ -3,7 +3,7 @@ MNIST Addition

.. raw:: html
<p>For detailed code implementation, please view it on <a class="reference external" href="https://github.com/AbductiveLearning/ABLKit/tree/main/examples/mnist_add" target="_blank">GitHub</a>.</p>
<p>For detailed code implementation, please view it on <a class="reference external" href="https://github.com/AbductiveLearning/ABLkit/tree/main/examples/mnist_add" target="_blank">GitHub</a>.</p>

Below shows an implementation of `MNIST
Addition <https://arxiv.org/abs/1805.10872>`__. In this task, pairs of


+ 1
- 1
docs/Examples/Zoo.rst View File

@@ -3,7 +3,7 @@ Zoo

.. raw:: html
<p>For detailed code implementation, please view it on <a class="reference external" href="https://github.com/AbductiveLearning/ABLKit/tree/main/examples/zoo" target="_blank">GitHub</a>.</p>
<p>For detailed code implementation, please view it on <a class="reference external" href="https://github.com/AbductiveLearning/ABLkit/tree/main/examples/zoo" target="_blank">GitHub</a>.</p>

Below shows an implementation of
`Zoo <https://archive.ics.uci.edu/dataset/111/zoo>`__ dataset. In this task,


+ 2
- 2
docs/Overview/Installation.rst View File

@@ -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


+ 3
- 3
docs/README.rst View File

@@ -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


+ 2
- 2
pyproject.toml View File

@@ -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 = [


Loading…
Cancel
Save