From 40c5d6f1b513a14c59914dcedfe31eccb5f5203f Mon Sep 17 00:00:00 2001 From: troyyyyy Date: Sun, 17 Dec 2023 17:02:01 +0800 Subject: [PATCH] [DOC] unify letter case --- abl/bridge/base_bridge.py | 2 +- abl/bridge/simple_bridge.py | 2 +- docs/Intro/Basics.rst | 7 ++++--- docs/Intro/Bridge.rst | 2 +- 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/abl/bridge/base_bridge.py b/abl/bridge/base_bridge.py index 60c47e0..f4e168b 100644 --- a/abl/bridge/base_bridge.py +++ b/abl/bridge/base_bridge.py @@ -11,7 +11,7 @@ class BaseBridge(metaclass=ABCMeta): A base class for bridging learning and reasoning parts. This class provides necessary methods that need to be overridden in subclasses - to construct a typical pipeline of Abductive learning (corresponding to ``train``), + to construct a typical pipeline of Abductive Learning (corresponding to ``train``), which involves the following four methods: - predict: Predict class indices on the given data samples. diff --git a/abl/bridge/simple_bridge.py b/abl/bridge/simple_bridge.py index fbe5bb1..5835619 100644 --- a/abl/bridge/simple_bridge.py +++ b/abl/bridge/simple_bridge.py @@ -15,7 +15,7 @@ class SimpleBridge(BaseBridge): """ A basic implementation for bridging machine learning and reasoning parts. - This class implements the typical pipeline of Abductive learning, which involves + This class implements the typical pipeline of Abductive Learning, which involves the following five steps: - Predict class probabilities and indices for the given data samples. diff --git a/docs/Intro/Basics.rst b/docs/Intro/Basics.rst index 4236d56..b68edd8 100644 --- a/docs/Intro/Basics.rst +++ b/docs/Intro/Basics.rst @@ -75,8 +75,8 @@ To implement this process, the following five steps are necessary: 2. Build the learning part - Build a machine learning model that can predict inputs to pseudo labels. - Then, use ``ABLModel`` to encapsulate the model. + Build a base machine learning model that can predict inputs to pseudo labels. + Then, use ``ABLModel`` to encapsulate the base model. 3. Build the reasoning part @@ -87,7 +87,8 @@ To implement this process, the following five steps are necessary: 4. Define Evaluation Metrics - Define the metrics for measuring accuracy by inheriting from ``BaseMetric``. + Define the metrics by building a subclass of ``BaseMetric``. The metrics will + specify how to measure performance during the training and testing of the ABL framework. 5. Bridge learning and reasoning diff --git a/docs/Intro/Bridge.rst b/docs/Intro/Bridge.rst index 19d0ddd..2e75030 100644 --- a/docs/Intro/Bridge.rst +++ b/docs/Intro/Bridge.rst @@ -10,7 +10,7 @@ Bridge ====== -Bridging learning and reasoning part to train the model is the fundamental idea of Abductive Learning. ABL-Package implements a set of bridge classes to achieve this. +Bridging learning and reasoning parts to train the model is the fundamental idea of Abductive Learning. ABL-Package implements a set of bridge classes to achieve this. ``BaseBridge`` is an abstract class with the following initialization parameters: