Hasan Iqbal
		
	commited on
		
		
					Added API References in documentation
Browse filesThis view is limited to 50 files because it contains too many changes.  
							See raw diff
- docs/src/_templates/class.md +37 -0
- docs/src/_templates/class.rst +33 -0
- docs/src/api/index.md +0 -1
- docs/src/conf.py +9 -6
- docs/src/index.md +6 -2
- docs/src/reference/api/openfactcheck.FactCheckerState.rst +25 -0
- docs/src/reference/api/openfactcheck.OpenFactCheck.rst +39 -0
- docs/src/reference/api/openfactcheck.Solver.rst +26 -0
- docs/src/reference/api/openfactcheck.StandardTaskSolver.rst +32 -0
- docs/src/reference/api/openfactcheck.errors.ConfigError.rst +6 -0
- docs/src/reference/api/openfactcheck.errors.ConfigValidationError.rst +6 -0
- docs/src/reference/api/openfactcheck.evaluator.CheckerEvaluator.rst +24 -0
- docs/src/reference/api/openfactcheck.evaluator.LLMEvaluator.rst +51 -0
- docs/src/reference/api/openfactcheck.evaluator.ResponseEvaluator.rst +27 -0
- docs/src/reference/api/openfactcheck.lib.CustomFileLoggingFormatter.rst +37 -0
- docs/src/reference/api/openfactcheck.lib.CustomStreamLoggingFormatter.rst +44 -0
- docs/src/reference/api/openfactcheck.lib.OpenFactCheckConfig.rst +24 -0
- docs/src/reference/api/openfactcheck.lib.SolversConfig.rst +23 -0
- docs/src/reference/api/openfactcheck.lib.get_logger.rst +6 -0
- docs/src/reference/api/openfactcheck.lib.set_logger_level.rst +6 -0
- docs/src/reference/api/openfactcheck.solvers.dummy.confused_claim_examiner.ConfusedClaimExaminer.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.dummy.fake_claim_extractor.FakeClaimExtractor.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.dummy.ignorant_search_engine_retriever.IgnorantSearchEngineRetriever.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.dummy.useless_response_regenerator.UselessResponseRegenerator.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_cp.FactCheckGPTClaimProcessor.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_rtv.FactCheckGPTRetriever.rst +42 -0
- docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_vfr.FactCheckGPTVerifier.rst +36 -0
- docs/src/reference/api/openfactcheck.solvers.factool.all_pass_abstain_detector.AllPassAbstainDetector.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.factool.concat_response_regenerator.ConcatResponseRegenerator.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.factool.factool_blackbox.FactoolBlackboxSolver.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.factool.factool_blackbox_post_editor.FactoolBlackboxPostEditor.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.factool.factool_claim_examiner.FactoolClaimExaminer.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.factool.factool_decontextualizer.FactoolDecontextualizer.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.factool.factool_evidence_retriever.FactoolEvidenceRetriever.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.factool.factool_post_editor.FactoolPostEditor.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.rarr.rarr_agreement_gate.RARRAgreementGate.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.rarr.rarr_concat_response_regenerator.RARRConcatResponseRegenerator.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.rarr.rarr_editor.RARREditor.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.rarr.rarr_llm_retriever.RARRLLMRetriever.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.rarr.rarr_question_generator.RARRQuestionGenerator.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.rarr.rarr_search_engine_retriever.RARRSearchEngineRetriever.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.tutorial.all_pass_abstain_detector.AllPassAbstainDetector.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_decontextulizer.ChatGPTDecontextualizer.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_post_editor.ChatGPTPostEditor.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_worthiness_filter.ChatGPTWorthinessFilter.rst +33 -0
- docs/src/reference/api/openfactcheck.solvers.tutorial.concat_response_regenerator.ConcatResponseRegenerator.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.tutorial.search_engine_evidence_retriever.SearchEngineEvidenceRetriever.rst +35 -0
- docs/src/reference/api/openfactcheck.solvers.tutorial.spacy_response_decomposer.SpacyResponseDecomposer.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.webservice.factcheckgpt_cp.FactCheckGPTClaimProcessor.rst +32 -0
- docs/src/reference/api/openfactcheck.solvers.webservice.factcheckgpt_rtv.FactCheckGPTRetriever.rst +42 -0
    	
        docs/src/_templates/class.md
    ADDED
    
    | @@ -0,0 +1,37 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            {{ fullname | escape | underline}}
         | 
| 2 | 
            +
             | 
| 3 | 
            +
            ```{eval-rst}
         | 
| 4 | 
            +
            .. currentmodule:: {{ module }}
         | 
| 5 | 
            +
            ```
         | 
| 6 | 
            +
             | 
| 7 | 
            +
            % add toctree option to make autodoc generate the pages
         | 
| 8 | 
            +
             | 
| 9 | 
            +
            ```{eval-rst}
         | 
| 10 | 
            +
            .. autoclass:: {{ objname }}
         | 
| 11 | 
            +
             | 
| 12 | 
            +
               {% block attributes %}
         | 
| 13 | 
            +
               {% if attributes %}
         | 
| 14 | 
            +
               .. rubric:: Attributes
         | 
| 15 | 
            +
             | 
| 16 | 
            +
               .. autosummary::
         | 
| 17 | 
            +
                  :toctree: .
         | 
| 18 | 
            +
               {% for item in attributes %}
         | 
| 19 | 
            +
                  ~{{ name }}.{{ item }}
         | 
| 20 | 
            +
               {%- endfor %}
         | 
| 21 | 
            +
               {% endif %}
         | 
| 22 | 
            +
               {% endblock %}
         | 
| 23 | 
            +
             | 
| 24 | 
            +
               {% block methods %}
         | 
| 25 | 
            +
               {% if methods %}
         | 
| 26 | 
            +
               .. rubric:: Methods
         | 
| 27 | 
            +
             | 
| 28 | 
            +
               .. autosummary::
         | 
| 29 | 
            +
                  :toctree: .
         | 
| 30 | 
            +
               {% for item in methods %}
         | 
| 31 | 
            +
                  {%- if item != '__init__' %}
         | 
| 32 | 
            +
                  ~{{ name }}.{{ item }}
         | 
| 33 | 
            +
                  {%- endif -%}
         | 
| 34 | 
            +
               {%- endfor %}
         | 
| 35 | 
            +
               {% endif %}
         | 
| 36 | 
            +
               {% endblock %}
         | 
| 37 | 
            +
            ```
         | 
    	
        docs/src/_templates/class.rst
    ADDED
    
    | @@ -0,0 +1,33 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            {{ fullname | escape | underline}}
         | 
| 2 | 
            +
             | 
| 3 | 
            +
            .. currentmodule:: {{ module }}
         | 
| 4 | 
            +
             | 
| 5 | 
            +
            .. add toctree option to make autodoc generate the pages
         | 
| 6 | 
            +
             | 
| 7 | 
            +
            .. autoclass:: {{ objname }}
         | 
| 8 | 
            +
             | 
| 9 | 
            +
               {% block attributes %}
         | 
| 10 | 
            +
               {% if attributes %}
         | 
| 11 | 
            +
               .. rubric:: Attributes
         | 
| 12 | 
            +
             | 
| 13 | 
            +
               .. autosummary::
         | 
| 14 | 
            +
                  :toctree: .
         | 
| 15 | 
            +
               {% for item in attributes %}
         | 
| 16 | 
            +
                  ~{{ name }}.{{ item }}
         | 
| 17 | 
            +
               {%- endfor %}
         | 
| 18 | 
            +
               {% endif %}
         | 
| 19 | 
            +
               {% endblock %}
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               {% block methods %}
         | 
| 22 | 
            +
               {% if methods %}
         | 
| 23 | 
            +
               .. rubric:: Methods
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
                  :toctree: .
         | 
| 27 | 
            +
               {% for item in methods %}
         | 
| 28 | 
            +
                  {%- if item != '__init__' %}
         | 
| 29 | 
            +
                  ~{{ name }}.{{ item }}
         | 
| 30 | 
            +
                  {%- endif -%}
         | 
| 31 | 
            +
               {%- endfor %}
         | 
| 32 | 
            +
               {% endif %}
         | 
| 33 | 
            +
               {% endblock %}
         | 
    	
        docs/src/api/index.md
    DELETED
    
    | @@ -1 +0,0 @@ | |
| 1 | 
            -
            # API Reference
         | 
|  | |
|  | 
    	
        docs/src/conf.py
    CHANGED
    
    | @@ -18,6 +18,7 @@ import openfactcheck | |
| 18 | 
             
            from sphinx.application import Sphinx
         | 
| 19 | 
             
            from sphinx.locale import _
         | 
| 20 |  | 
|  | |
| 21 | 
             
            sys.path.append(str(Path(".").resolve()))
         | 
| 22 |  | 
| 23 | 
             
            # -- Project information -----------------------------------------------------
         | 
| @@ -243,13 +244,15 @@ favicons = [ | |
| 243 | 
             
            ]
         | 
| 244 |  | 
| 245 | 
             
            # -- Options for autosummary/autodoc output ------------------------------------
         | 
| 246 | 
            -
             | 
| 247 | 
            -
             | 
| 248 | 
            -
             | 
| 249 |  | 
| 250 | 
             
            # -- Options for autoapi -------------------------------------------------------
         | 
| 251 | 
             
            # autoapi_type = "python"
         | 
| 252 | 
            -
            # autoapi_dirs = [ | 
|  | |
|  | |
| 253 | 
             
            # autoapi_keep_files = True
         | 
| 254 | 
             
            # autoapi_root = "api"
         | 
| 255 | 
             
            # autoapi_member_order = "groupwise"
         | 
| @@ -309,11 +312,11 @@ def linkcode_resolve(domain, info) -> str | None: | |
| 309 | 
             
                fn = os.path.relpath(fn, start=os.path.dirname(openfactcheck.__file__))
         | 
| 310 |  | 
| 311 | 
             
                if "+" in openfactcheck.__version__:
         | 
| 312 | 
            -
                    return f"https://github.com/hasaniqbal777/openfactcheck/blob/main/openfactcheck/{fn}{linespec}"
         | 
| 313 | 
             
                else:
         | 
| 314 | 
             
                    return (
         | 
| 315 | 
             
                        f"https://github.com/hasaniqbal777/openfactcheck/blob/"
         | 
| 316 | 
            -
                        f"v{openfactcheck.__version__}/openfactcheck/{fn}{linespec}"
         | 
| 317 | 
             
                    )
         | 
| 318 |  | 
| 319 | 
             
            def setup_to_main(
         | 
|  | |
| 18 | 
             
            from sphinx.application import Sphinx
         | 
| 19 | 
             
            from sphinx.locale import _
         | 
| 20 |  | 
| 21 | 
            +
            sys.path.insert(0, os.path.abspath('../../src/openfactcheck'))
         | 
| 22 | 
             
            sys.path.append(str(Path(".").resolve()))
         | 
| 23 |  | 
| 24 | 
             
            # -- Project information -----------------------------------------------------
         | 
|  | |
| 244 | 
             
            ]
         | 
| 245 |  | 
| 246 | 
             
            # -- Options for autosummary/autodoc output ------------------------------------
         | 
| 247 | 
            +
            autosummary_generate = True
         | 
| 248 | 
            +
            autodoc_typehints = "description"
         | 
| 249 | 
            +
            autodoc_member_order = "groupwise"
         | 
| 250 |  | 
| 251 | 
             
            # -- Options for autoapi -------------------------------------------------------
         | 
| 252 | 
             
            # autoapi_type = "python"
         | 
| 253 | 
            +
            # autoapi_dirs = [
         | 
| 254 | 
            +
            #     "../../src/openfactcheck/lib",
         | 
| 255 | 
            +
            # ]
         | 
| 256 | 
             
            # autoapi_keep_files = True
         | 
| 257 | 
             
            # autoapi_root = "api"
         | 
| 258 | 
             
            # autoapi_member_order = "groupwise"
         | 
|  | |
| 312 | 
             
                fn = os.path.relpath(fn, start=os.path.dirname(openfactcheck.__file__))
         | 
| 313 |  | 
| 314 | 
             
                if "+" in openfactcheck.__version__:
         | 
| 315 | 
            +
                    return f"https://github.com/hasaniqbal777/openfactcheck/blob/main/src/openfactcheck/{fn}{linespec}"
         | 
| 316 | 
             
                else:
         | 
| 317 | 
             
                    return (
         | 
| 318 | 
             
                        f"https://github.com/hasaniqbal777/openfactcheck/blob/"
         | 
| 319 | 
            +
                        f"v{openfactcheck.__version__}/src/openfactcheck/{fn}{linespec}"
         | 
| 320 | 
             
                    )
         | 
| 321 |  | 
| 322 | 
             
            def setup_to_main(
         | 
    	
        docs/src/index.md
    CHANGED
    
    | @@ -35,6 +35,10 @@ It consists of three core modules: | |
| 35 |  | 
| 36 | 
             
            Explore the documentation to learn more about the library, its features, how to use and contribute to it, and more.
         | 
| 37 |  | 
|  | |
|  | |
|  | |
|  | |
| 38 | 
             
            ```{eval-rst}
         | 
| 39 | 
             
            .. grid:: 1 2 2 2
         | 
| 40 | 
             
                :gutter: 4
         | 
| @@ -86,7 +90,7 @@ Explore the documentation to learn more about the library, its features, how to | |
| 86 |  | 
| 87 | 
             
                    +++
         | 
| 88 |  | 
| 89 | 
            -
                    .. button-ref::  | 
| 90 | 
             
                        :ref-type: doc
         | 
| 91 | 
             
                        :color: secondary
         | 
| 92 | 
             
                        :expand:
         | 
| @@ -124,6 +128,6 @@ Explore the documentation to learn more about the library, its features, how to | |
| 124 |  | 
| 125 | 
             
            getting_started/index
         | 
| 126 | 
             
            user_guide/index
         | 
| 127 | 
            -
             | 
| 128 | 
             
            development/index
         | 
| 129 | 
             
            ```
         | 
|  | |
| 35 |  | 
| 36 | 
             
            Explore the documentation to learn more about the library, its features, how to use and contribute to it, and more.
         | 
| 37 |  | 
| 38 | 
            +
            ```{warning}
         | 
| 39 | 
            +
            The API and documentation are still under heavy development and may change in future versions.
         | 
| 40 | 
            +
            ```
         | 
| 41 | 
            +
             | 
| 42 | 
             
            ```{eval-rst}
         | 
| 43 | 
             
            .. grid:: 1 2 2 2
         | 
| 44 | 
             
                :gutter: 4
         | 
|  | |
| 90 |  | 
| 91 | 
             
                    +++
         | 
| 92 |  | 
| 93 | 
            +
                    .. button-ref:: reference/index
         | 
| 94 | 
             
                        :ref-type: doc
         | 
| 95 | 
             
                        :color: secondary
         | 
| 96 | 
             
                        :expand:
         | 
|  | |
| 128 |  | 
| 129 | 
             
            getting_started/index
         | 
| 130 | 
             
            user_guide/index
         | 
| 131 | 
            +
            reference/index
         | 
| 132 | 
             
            development/index
         | 
| 133 | 
             
            ```
         | 
    	
        docs/src/reference/api/openfactcheck.FactCheckerState.rst
    ADDED
    
    | @@ -0,0 +1,25 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.FactCheckerState
         | 
| 2 | 
            +
            ==============================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: FactCheckerState
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~FactCheckerState.__init__
         | 
| 17 | 
            +
                  ~FactCheckerState.get
         | 
| 18 | 
            +
                  ~FactCheckerState.set
         | 
| 19 | 
            +
                  ~FactCheckerState.to_dict
         | 
| 20 | 
            +
               
         | 
| 21 | 
            +
               
         | 
| 22 | 
            +
             | 
| 23 | 
            +
               
         | 
| 24 | 
            +
               
         | 
| 25 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.OpenFactCheck.rst
    ADDED
    
    | @@ -0,0 +1,39 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.OpenFactCheck
         | 
| 2 | 
            +
            ===========================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: OpenFactCheck
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~OpenFactCheck.__init__
         | 
| 17 | 
            +
                  ~OpenFactCheck.init_pipeline
         | 
| 18 | 
            +
                  ~OpenFactCheck.init_pipeline_manually
         | 
| 19 | 
            +
                  ~OpenFactCheck.init_solver
         | 
| 20 | 
            +
                  ~OpenFactCheck.init_solvers
         | 
| 21 | 
            +
                  ~OpenFactCheck.list_claimprocessors
         | 
| 22 | 
            +
                  ~OpenFactCheck.list_retrievers
         | 
| 23 | 
            +
                  ~OpenFactCheck.list_solvers
         | 
| 24 | 
            +
                  ~OpenFactCheck.list_verifiers
         | 
| 25 | 
            +
                  ~OpenFactCheck.load_solvers
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
               
         | 
| 28 | 
            +
             | 
| 29 | 
            +
               
         | 
| 30 | 
            +
               
         | 
| 31 | 
            +
               .. rubric:: Attributes
         | 
| 32 | 
            +
             | 
| 33 | 
            +
               .. autosummary::
         | 
| 34 | 
            +
               
         | 
| 35 | 
            +
                  ~OpenFactCheck.FactCheckerEvaluator
         | 
| 36 | 
            +
                  ~OpenFactCheck.LLMEvaluator
         | 
| 37 | 
            +
                  ~OpenFactCheck.ResponseEvaluator
         | 
| 38 | 
            +
               
         | 
| 39 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.Solver.rst
    ADDED
    
    | @@ -0,0 +1,26 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.Solver
         | 
| 2 | 
            +
            ====================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: Solver
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~Solver.__init__
         | 
| 17 | 
            +
                  ~Solver.load
         | 
| 18 | 
            +
                  ~Solver.load_from_directory
         | 
| 19 | 
            +
                  ~Solver.load_from_file
         | 
| 20 | 
            +
                  ~Solver.register
         | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
             | 
| 24 | 
            +
               
         | 
| 25 | 
            +
               
         | 
| 26 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.StandardTaskSolver.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.StandardTaskSolver
         | 
| 2 | 
            +
            ================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: StandardTaskSolver
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~StandardTaskSolver.__init__
         | 
| 17 | 
            +
                  ~StandardTaskSolver.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~StandardTaskSolver.global_config
         | 
| 28 | 
            +
                  ~StandardTaskSolver.input_name
         | 
| 29 | 
            +
                  ~StandardTaskSolver.name
         | 
| 30 | 
            +
                  ~StandardTaskSolver.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.errors.ConfigError.rst
    ADDED
    
    | @@ -0,0 +1,6 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.errors.ConfigError
         | 
| 2 | 
            +
            ================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.errors
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoexception:: ConfigError
         | 
    	
        docs/src/reference/api/openfactcheck.errors.ConfigValidationError.rst
    ADDED
    
    | @@ -0,0 +1,6 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.errors.ConfigValidationError
         | 
| 2 | 
            +
            ==========================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.errors
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoexception:: ConfigValidationError
         | 
    	
        docs/src/reference/api/openfactcheck.evaluator.CheckerEvaluator.rst
    ADDED
    
    | @@ -0,0 +1,24 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.evaluator.CheckerEvaluator
         | 
| 2 | 
            +
            ========================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.evaluator
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: CheckerEvaluator
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~CheckerEvaluator.__init__
         | 
| 17 | 
            +
                  ~CheckerEvaluator.evaluate
         | 
| 18 | 
            +
                  ~CheckerEvaluator.evaluate_binary_classification
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
               
         | 
| 21 | 
            +
             | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               
         | 
| 24 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.evaluator.LLMEvaluator.rst
    ADDED
    
    | @@ -0,0 +1,51 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.evaluator.LLMEvaluator
         | 
| 2 | 
            +
            ====================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.evaluator
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: LLMEvaluator
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~LLMEvaluator.__init__
         | 
| 17 | 
            +
                  ~LLMEvaluator.assess_freetext
         | 
| 18 | 
            +
                  ~LLMEvaluator.calculate_price
         | 
| 19 | 
            +
                  ~LLMEvaluator.call_fresheval
         | 
| 20 | 
            +
                  ~LLMEvaluator.call_openai_api
         | 
| 21 | 
            +
                  ~LLMEvaluator.cut_sentences
         | 
| 22 | 
            +
                  ~LLMEvaluator.cut_sub_string
         | 
| 23 | 
            +
                  ~LLMEvaluator.evaluate
         | 
| 24 | 
            +
                  ~LLMEvaluator.evaluate_freetext
         | 
| 25 | 
            +
                  ~LLMEvaluator.evaluate_freshqa
         | 
| 26 | 
            +
                  ~LLMEvaluator.evaluate_selfaware
         | 
| 27 | 
            +
                  ~LLMEvaluator.evaluate_snowballing
         | 
| 28 | 
            +
                  ~LLMEvaluator.extract_ratings
         | 
| 29 | 
            +
                  ~LLMEvaluator.filter_responses
         | 
| 30 | 
            +
                  ~LLMEvaluator.freetext_barplot
         | 
| 31 | 
            +
                  ~LLMEvaluator.freshqa_piechart
         | 
| 32 | 
            +
                  ~LLMEvaluator.generate_plots
         | 
| 33 | 
            +
                  ~LLMEvaluator.generate_report
         | 
| 34 | 
            +
                  ~LLMEvaluator.get_boolean
         | 
| 35 | 
            +
                  ~LLMEvaluator.get_unanswerable
         | 
| 36 | 
            +
                  ~LLMEvaluator.group_cosine_similarity
         | 
| 37 | 
            +
                  ~LLMEvaluator.read_evaluations
         | 
| 38 | 
            +
                  ~LLMEvaluator.read_input
         | 
| 39 | 
            +
                  ~LLMEvaluator.read_results
         | 
| 40 | 
            +
                  ~LLMEvaluator.remove_punctuation
         | 
| 41 | 
            +
                  ~LLMEvaluator.selfaware_barplot
         | 
| 42 | 
            +
                  ~LLMEvaluator.selfaware_cm
         | 
| 43 | 
            +
                  ~LLMEvaluator.snowballing_barplot
         | 
| 44 | 
            +
                  ~LLMEvaluator.snowballing_cm
         | 
| 45 | 
            +
                  ~LLMEvaluator.sum_all_elements
         | 
| 46 | 
            +
               
         | 
| 47 | 
            +
               
         | 
| 48 | 
            +
             | 
| 49 | 
            +
               
         | 
| 50 | 
            +
               
         | 
| 51 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.evaluator.ResponseEvaluator.rst
    ADDED
    
    | @@ -0,0 +1,27 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.evaluator.ResponseEvaluator
         | 
| 2 | 
            +
            =========================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.evaluator
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: ResponseEvaluator
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~ResponseEvaluator.__init__
         | 
| 17 | 
            +
                  ~ResponseEvaluator.evaluate
         | 
| 18 | 
            +
                  ~ResponseEvaluator.evaluate_streaming
         | 
| 19 | 
            +
                  ~ResponseEvaluator.persist_output
         | 
| 20 | 
            +
                  ~ResponseEvaluator.read_output
         | 
| 21 | 
            +
                  ~ResponseEvaluator.remove_output
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.lib.CustomFileLoggingFormatter.rst
    ADDED
    
    | @@ -0,0 +1,37 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.lib.CustomFileLoggingFormatter
         | 
| 2 | 
            +
            ============================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.lib
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: CustomFileLoggingFormatter
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~CustomFileLoggingFormatter.__init__
         | 
| 17 | 
            +
                  ~CustomFileLoggingFormatter.converter
         | 
| 18 | 
            +
                  ~CustomFileLoggingFormatter.format
         | 
| 19 | 
            +
                  ~CustomFileLoggingFormatter.formatException
         | 
| 20 | 
            +
                  ~CustomFileLoggingFormatter.formatMessage
         | 
| 21 | 
            +
                  ~CustomFileLoggingFormatter.formatStack
         | 
| 22 | 
            +
                  ~CustomFileLoggingFormatter.formatTime
         | 
| 23 | 
            +
                  ~CustomFileLoggingFormatter.usesTime
         | 
| 24 | 
            +
               
         | 
| 25 | 
            +
               
         | 
| 26 | 
            +
             | 
| 27 | 
            +
               
         | 
| 28 | 
            +
               
         | 
| 29 | 
            +
               .. rubric:: Attributes
         | 
| 30 | 
            +
             | 
| 31 | 
            +
               .. autosummary::
         | 
| 32 | 
            +
               
         | 
| 33 | 
            +
                  ~CustomFileLoggingFormatter.default_msec_format
         | 
| 34 | 
            +
                  ~CustomFileLoggingFormatter.default_time_format
         | 
| 35 | 
            +
                  ~CustomFileLoggingFormatter.log_format
         | 
| 36 | 
            +
               
         | 
| 37 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.lib.CustomStreamLoggingFormatter.rst
    ADDED
    
    | @@ -0,0 +1,44 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.lib.CustomStreamLoggingFormatter
         | 
| 2 | 
            +
            ==============================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.lib
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: CustomStreamLoggingFormatter
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~CustomStreamLoggingFormatter.__init__
         | 
| 17 | 
            +
                  ~CustomStreamLoggingFormatter.converter
         | 
| 18 | 
            +
                  ~CustomStreamLoggingFormatter.format
         | 
| 19 | 
            +
                  ~CustomStreamLoggingFormatter.formatException
         | 
| 20 | 
            +
                  ~CustomStreamLoggingFormatter.formatMessage
         | 
| 21 | 
            +
                  ~CustomStreamLoggingFormatter.formatStack
         | 
| 22 | 
            +
                  ~CustomStreamLoggingFormatter.formatTime
         | 
| 23 | 
            +
                  ~CustomStreamLoggingFormatter.usesTime
         | 
| 24 | 
            +
               
         | 
| 25 | 
            +
               
         | 
| 26 | 
            +
             | 
| 27 | 
            +
               
         | 
| 28 | 
            +
               
         | 
| 29 | 
            +
               .. rubric:: Attributes
         | 
| 30 | 
            +
             | 
| 31 | 
            +
               .. autosummary::
         | 
| 32 | 
            +
               
         | 
| 33 | 
            +
                  ~CustomStreamLoggingFormatter.FORMATS
         | 
| 34 | 
            +
                  ~CustomStreamLoggingFormatter.bold_red
         | 
| 35 | 
            +
                  ~CustomStreamLoggingFormatter.default_msec_format
         | 
| 36 | 
            +
                  ~CustomStreamLoggingFormatter.default_time_format
         | 
| 37 | 
            +
                  ~CustomStreamLoggingFormatter.green
         | 
| 38 | 
            +
                  ~CustomStreamLoggingFormatter.grey
         | 
| 39 | 
            +
                  ~CustomStreamLoggingFormatter.log_format
         | 
| 40 | 
            +
                  ~CustomStreamLoggingFormatter.red
         | 
| 41 | 
            +
                  ~CustomStreamLoggingFormatter.reset
         | 
| 42 | 
            +
                  ~CustomStreamLoggingFormatter.yellow
         | 
| 43 | 
            +
               
         | 
| 44 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.lib.OpenFactCheckConfig.rst
    ADDED
    
    | @@ -0,0 +1,24 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.lib.OpenFactCheckConfig
         | 
| 2 | 
            +
            =====================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.lib
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: OpenFactCheckConfig
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~OpenFactCheckConfig.__init__
         | 
| 17 | 
            +
                  ~OpenFactCheckConfig.solver_configuration
         | 
| 18 | 
            +
                  ~OpenFactCheckConfig.validate
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
               
         | 
| 21 | 
            +
             | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               
         | 
| 24 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.lib.SolversConfig.rst
    ADDED
    
    | @@ -0,0 +1,23 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.lib.SolversConfig
         | 
| 2 | 
            +
            ===============================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.lib
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: SolversConfig
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~SolversConfig.__init__
         | 
| 17 | 
            +
                  ~SolversConfig.load_config
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.lib.get_logger.rst
    ADDED
    
    | @@ -0,0 +1,6 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.lib.get\_logger
         | 
| 2 | 
            +
            =============================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.lib
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autofunction:: get_logger
         | 
    	
        docs/src/reference/api/openfactcheck.lib.set_logger_level.rst
    ADDED
    
    | @@ -0,0 +1,6 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.lib.set\_logger\_level
         | 
| 2 | 
            +
            ====================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.lib
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autofunction:: set_logger_level
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.dummy.confused_claim_examiner.ConfusedClaimExaminer.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.dummy.confused\_claim\_examiner.ConfusedClaimExaminer
         | 
| 2 | 
            +
            ===========================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.dummy.confused_claim_examiner
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: ConfusedClaimExaminer
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~ConfusedClaimExaminer.__init__
         | 
| 17 | 
            +
                  ~ConfusedClaimExaminer.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~ConfusedClaimExaminer.global_config
         | 
| 28 | 
            +
                  ~ConfusedClaimExaminer.input_name
         | 
| 29 | 
            +
                  ~ConfusedClaimExaminer.name
         | 
| 30 | 
            +
                  ~ConfusedClaimExaminer.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.dummy.fake_claim_extractor.FakeClaimExtractor.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.dummy.fake\_claim\_extractor.FakeClaimExtractor
         | 
| 2 | 
            +
            =====================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.dummy.fake_claim_extractor
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: FakeClaimExtractor
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~FakeClaimExtractor.__init__
         | 
| 17 | 
            +
                  ~FakeClaimExtractor.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~FakeClaimExtractor.global_config
         | 
| 28 | 
            +
                  ~FakeClaimExtractor.input_name
         | 
| 29 | 
            +
                  ~FakeClaimExtractor.name
         | 
| 30 | 
            +
                  ~FakeClaimExtractor.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.dummy.ignorant_search_engine_retriever.IgnorantSearchEngineRetriever.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.dummy.ignorant\_search\_engine\_retriever.IgnorantSearchEngineRetriever
         | 
| 2 | 
            +
            =============================================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.dummy.ignorant_search_engine_retriever
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: IgnorantSearchEngineRetriever
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~IgnorantSearchEngineRetriever.__init__
         | 
| 17 | 
            +
                  ~IgnorantSearchEngineRetriever.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~IgnorantSearchEngineRetriever.global_config
         | 
| 28 | 
            +
                  ~IgnorantSearchEngineRetriever.input_name
         | 
| 29 | 
            +
                  ~IgnorantSearchEngineRetriever.name
         | 
| 30 | 
            +
                  ~IgnorantSearchEngineRetriever.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.dummy.useless_response_regenerator.UselessResponseRegenerator.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.dummy.useless\_response\_regenerator.UselessResponseRegenerator
         | 
| 2 | 
            +
            =====================================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.dummy.useless_response_regenerator
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: UselessResponseRegenerator
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~UselessResponseRegenerator.__init__
         | 
| 17 | 
            +
                  ~UselessResponseRegenerator.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~UselessResponseRegenerator.global_config
         | 
| 28 | 
            +
                  ~UselessResponseRegenerator.input_name
         | 
| 29 | 
            +
                  ~UselessResponseRegenerator.name
         | 
| 30 | 
            +
                  ~UselessResponseRegenerator.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_cp.FactCheckGPTClaimProcessor.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.factcheckgpt.factcheckgpt\_cp.FactCheckGPTClaimProcessor
         | 
| 2 | 
            +
            ==============================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.factcheckgpt.factcheckgpt_cp
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: FactCheckGPTClaimProcessor
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~FactCheckGPTClaimProcessor.__init__
         | 
| 17 | 
            +
                  ~FactCheckGPTClaimProcessor.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~FactCheckGPTClaimProcessor.global_config
         | 
| 28 | 
            +
                  ~FactCheckGPTClaimProcessor.input_name
         | 
| 29 | 
            +
                  ~FactCheckGPTClaimProcessor.name
         | 
| 30 | 
            +
                  ~FactCheckGPTClaimProcessor.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_rtv.FactCheckGPTRetriever.rst
    ADDED
    
    | @@ -0,0 +1,42 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.factcheckgpt.factcheckgpt\_rtv.FactCheckGPTRetriever
         | 
| 2 | 
            +
            ==========================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.factcheckgpt.factcheckgpt_rtv
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: FactCheckGPTRetriever
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~FactCheckGPTRetriever.__init__
         | 
| 17 | 
            +
                  ~FactCheckGPTRetriever.build_solver
         | 
| 18 | 
            +
                  ~FactCheckGPTRetriever.chunk_text
         | 
| 19 | 
            +
                  ~FactCheckGPTRetriever.generate_questions
         | 
| 20 | 
            +
                  ~FactCheckGPTRetriever.get_relevant_snippets
         | 
| 21 | 
            +
                  ~FactCheckGPTRetriever.get_web_evidences_for_claim
         | 
| 22 | 
            +
                  ~FactCheckGPTRetriever.is_tag_visible
         | 
| 23 | 
            +
                  ~FactCheckGPTRetriever.remove_duplicate_questions
         | 
| 24 | 
            +
                  ~FactCheckGPTRetriever.retrieve_documents
         | 
| 25 | 
            +
                  ~FactCheckGPTRetriever.run_question_generation
         | 
| 26 | 
            +
                  ~FactCheckGPTRetriever.scrape_url
         | 
| 27 | 
            +
                  ~FactCheckGPTRetriever.search_google
         | 
| 28 | 
            +
               
         | 
| 29 | 
            +
               
         | 
| 30 | 
            +
             | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
| 33 | 
            +
               .. rubric:: Attributes
         | 
| 34 | 
            +
             | 
| 35 | 
            +
               .. autosummary::
         | 
| 36 | 
            +
               
         | 
| 37 | 
            +
                  ~FactCheckGPTRetriever.global_config
         | 
| 38 | 
            +
                  ~FactCheckGPTRetriever.input_name
         | 
| 39 | 
            +
                  ~FactCheckGPTRetriever.name
         | 
| 40 | 
            +
                  ~FactCheckGPTRetriever.output_name
         | 
| 41 | 
            +
               
         | 
| 42 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_vfr.FactCheckGPTVerifier.rst
    ADDED
    
    | @@ -0,0 +1,36 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.factcheckgpt.factcheckgpt\_vfr.FactCheckGPTVerifier
         | 
| 2 | 
            +
            =========================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.factcheckgpt.factcheckgpt_vfr
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: FactCheckGPTVerifier
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~FactCheckGPTVerifier.__init__
         | 
| 17 | 
            +
                  ~FactCheckGPTVerifier.build_solver
         | 
| 18 | 
            +
                  ~FactCheckGPTVerifier.identify_stance_gpt
         | 
| 19 | 
            +
                  ~FactCheckGPTVerifier.stance
         | 
| 20 | 
            +
                  ~FactCheckGPTVerifier.verify_by_stance
         | 
| 21 | 
            +
                  ~FactCheckGPTVerifier.verify_claim
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
               .. rubric:: Attributes
         | 
| 28 | 
            +
             | 
| 29 | 
            +
               .. autosummary::
         | 
| 30 | 
            +
               
         | 
| 31 | 
            +
                  ~FactCheckGPTVerifier.global_config
         | 
| 32 | 
            +
                  ~FactCheckGPTVerifier.input_name
         | 
| 33 | 
            +
                  ~FactCheckGPTVerifier.name
         | 
| 34 | 
            +
                  ~FactCheckGPTVerifier.output_name
         | 
| 35 | 
            +
               
         | 
| 36 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.factool.all_pass_abstain_detector.AllPassAbstainDetector.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.factool.all\_pass\_abstain\_detector.AllPassAbstainDetector
         | 
| 2 | 
            +
            =================================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.factool.all_pass_abstain_detector
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: AllPassAbstainDetector
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~AllPassAbstainDetector.__init__
         | 
| 17 | 
            +
                  ~AllPassAbstainDetector.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~AllPassAbstainDetector.global_config
         | 
| 28 | 
            +
                  ~AllPassAbstainDetector.input_name
         | 
| 29 | 
            +
                  ~AllPassAbstainDetector.name
         | 
| 30 | 
            +
                  ~AllPassAbstainDetector.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.factool.concat_response_regenerator.ConcatResponseRegenerator.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.factool.concat\_response\_regenerator.ConcatResponseRegenerator
         | 
| 2 | 
            +
            =====================================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.factool.concat_response_regenerator
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: ConcatResponseRegenerator
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~ConcatResponseRegenerator.__init__
         | 
| 17 | 
            +
                  ~ConcatResponseRegenerator.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~ConcatResponseRegenerator.global_config
         | 
| 28 | 
            +
                  ~ConcatResponseRegenerator.input_name
         | 
| 29 | 
            +
                  ~ConcatResponseRegenerator.name
         | 
| 30 | 
            +
                  ~ConcatResponseRegenerator.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.factool.factool_blackbox.FactoolBlackboxSolver.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.factool.factool\_blackbox.FactoolBlackboxSolver
         | 
| 2 | 
            +
            =====================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.factool.factool_blackbox
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: FactoolBlackboxSolver
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~FactoolBlackboxSolver.__init__
         | 
| 17 | 
            +
                  ~FactoolBlackboxSolver.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~FactoolBlackboxSolver.global_config
         | 
| 28 | 
            +
                  ~FactoolBlackboxSolver.input_name
         | 
| 29 | 
            +
                  ~FactoolBlackboxSolver.name
         | 
| 30 | 
            +
                  ~FactoolBlackboxSolver.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.factool.factool_blackbox_post_editor.FactoolBlackboxPostEditor.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.factool.factool\_blackbox\_post\_editor.FactoolBlackboxPostEditor
         | 
| 2 | 
            +
            =======================================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.factool.factool_blackbox_post_editor
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: FactoolBlackboxPostEditor
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~FactoolBlackboxPostEditor.__init__
         | 
| 17 | 
            +
                  ~FactoolBlackboxPostEditor.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~FactoolBlackboxPostEditor.global_config
         | 
| 28 | 
            +
                  ~FactoolBlackboxPostEditor.input_name
         | 
| 29 | 
            +
                  ~FactoolBlackboxPostEditor.name
         | 
| 30 | 
            +
                  ~FactoolBlackboxPostEditor.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.factool.factool_claim_examiner.FactoolClaimExaminer.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.factool.factool\_claim\_examiner.FactoolClaimExaminer
         | 
| 2 | 
            +
            ===========================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.factool.factool_claim_examiner
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: FactoolClaimExaminer
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~FactoolClaimExaminer.__init__
         | 
| 17 | 
            +
                  ~FactoolClaimExaminer.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~FactoolClaimExaminer.global_config
         | 
| 28 | 
            +
                  ~FactoolClaimExaminer.input_name
         | 
| 29 | 
            +
                  ~FactoolClaimExaminer.name
         | 
| 30 | 
            +
                  ~FactoolClaimExaminer.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.factool.factool_decontextualizer.FactoolDecontextualizer.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.factool.factool\_decontextualizer.FactoolDecontextualizer
         | 
| 2 | 
            +
            ===============================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.factool.factool_decontextualizer
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: FactoolDecontextualizer
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~FactoolDecontextualizer.__init__
         | 
| 17 | 
            +
                  ~FactoolDecontextualizer.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~FactoolDecontextualizer.global_config
         | 
| 28 | 
            +
                  ~FactoolDecontextualizer.input_name
         | 
| 29 | 
            +
                  ~FactoolDecontextualizer.name
         | 
| 30 | 
            +
                  ~FactoolDecontextualizer.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.factool.factool_evidence_retriever.FactoolEvidenceRetriever.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.factool.factool\_evidence\_retriever.FactoolEvidenceRetriever
         | 
| 2 | 
            +
            ===================================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.factool.factool_evidence_retriever
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: FactoolEvidenceRetriever
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~FactoolEvidenceRetriever.__init__
         | 
| 17 | 
            +
                  ~FactoolEvidenceRetriever.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~FactoolEvidenceRetriever.global_config
         | 
| 28 | 
            +
                  ~FactoolEvidenceRetriever.input_name
         | 
| 29 | 
            +
                  ~FactoolEvidenceRetriever.name
         | 
| 30 | 
            +
                  ~FactoolEvidenceRetriever.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.factool.factool_post_editor.FactoolPostEditor.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.factool.factool\_post\_editor.FactoolPostEditor
         | 
| 2 | 
            +
            =====================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.factool.factool_post_editor
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: FactoolPostEditor
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~FactoolPostEditor.__init__
         | 
| 17 | 
            +
                  ~FactoolPostEditor.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~FactoolPostEditor.global_config
         | 
| 28 | 
            +
                  ~FactoolPostEditor.input_name
         | 
| 29 | 
            +
                  ~FactoolPostEditor.name
         | 
| 30 | 
            +
                  ~FactoolPostEditor.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.rarr.rarr_agreement_gate.RARRAgreementGate.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.rarr.rarr\_agreement\_gate.RARRAgreementGate
         | 
| 2 | 
            +
            ==================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.rarr.rarr_agreement_gate
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: RARRAgreementGate
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~RARRAgreementGate.__init__
         | 
| 17 | 
            +
                  ~RARRAgreementGate.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~RARRAgreementGate.global_config
         | 
| 28 | 
            +
                  ~RARRAgreementGate.input_name
         | 
| 29 | 
            +
                  ~RARRAgreementGate.name
         | 
| 30 | 
            +
                  ~RARRAgreementGate.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.rarr.rarr_concat_response_regenerator.RARRConcatResponseRegenerator.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.rarr.rarr\_concat\_response\_regenerator.RARRConcatResponseRegenerator
         | 
| 2 | 
            +
            ============================================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.rarr.rarr_concat_response_regenerator
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: RARRConcatResponseRegenerator
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~RARRConcatResponseRegenerator.__init__
         | 
| 17 | 
            +
                  ~RARRConcatResponseRegenerator.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~RARRConcatResponseRegenerator.global_config
         | 
| 28 | 
            +
                  ~RARRConcatResponseRegenerator.input_name
         | 
| 29 | 
            +
                  ~RARRConcatResponseRegenerator.name
         | 
| 30 | 
            +
                  ~RARRConcatResponseRegenerator.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.rarr.rarr_editor.RARREditor.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.rarr.rarr\_editor.RARREditor
         | 
| 2 | 
            +
            ==================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.rarr.rarr_editor
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: RARREditor
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~RARREditor.__init__
         | 
| 17 | 
            +
                  ~RARREditor.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~RARREditor.global_config
         | 
| 28 | 
            +
                  ~RARREditor.input_name
         | 
| 29 | 
            +
                  ~RARREditor.name
         | 
| 30 | 
            +
                  ~RARREditor.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.rarr.rarr_llm_retriever.RARRLLMRetriever.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.rarr.rarr\_llm\_retriever.RARRLLMRetriever
         | 
| 2 | 
            +
            ================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.rarr.rarr_llm_retriever
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: RARRLLMRetriever
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~RARRLLMRetriever.__init__
         | 
| 17 | 
            +
                  ~RARRLLMRetriever.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~RARRLLMRetriever.global_config
         | 
| 28 | 
            +
                  ~RARRLLMRetriever.input_name
         | 
| 29 | 
            +
                  ~RARRLLMRetriever.name
         | 
| 30 | 
            +
                  ~RARRLLMRetriever.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.rarr.rarr_question_generator.RARRQuestionGenerator.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.rarr.rarr\_question\_generator.RARRQuestionGenerator
         | 
| 2 | 
            +
            ==========================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.rarr.rarr_question_generator
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: RARRQuestionGenerator
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~RARRQuestionGenerator.__init__
         | 
| 17 | 
            +
                  ~RARRQuestionGenerator.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~RARRQuestionGenerator.global_config
         | 
| 28 | 
            +
                  ~RARRQuestionGenerator.input_name
         | 
| 29 | 
            +
                  ~RARRQuestionGenerator.name
         | 
| 30 | 
            +
                  ~RARRQuestionGenerator.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.rarr.rarr_search_engine_retriever.RARRSearchEngineRetriever.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.rarr.rarr\_search\_engine\_retriever.RARRSearchEngineRetriever
         | 
| 2 | 
            +
            ====================================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.rarr.rarr_search_engine_retriever
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: RARRSearchEngineRetriever
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~RARRSearchEngineRetriever.__init__
         | 
| 17 | 
            +
                  ~RARRSearchEngineRetriever.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~RARRSearchEngineRetriever.global_config
         | 
| 28 | 
            +
                  ~RARRSearchEngineRetriever.input_name
         | 
| 29 | 
            +
                  ~RARRSearchEngineRetriever.name
         | 
| 30 | 
            +
                  ~RARRSearchEngineRetriever.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.tutorial.all_pass_abstain_detector.AllPassAbstainDetector.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.tutorial.all\_pass\_abstain\_detector.AllPassAbstainDetector
         | 
| 2 | 
            +
            ==================================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.tutorial.all_pass_abstain_detector
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: AllPassAbstainDetector
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~AllPassAbstainDetector.__init__
         | 
| 17 | 
            +
                  ~AllPassAbstainDetector.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~AllPassAbstainDetector.global_config
         | 
| 28 | 
            +
                  ~AllPassAbstainDetector.input_name
         | 
| 29 | 
            +
                  ~AllPassAbstainDetector.name
         | 
| 30 | 
            +
                  ~AllPassAbstainDetector.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_decontextulizer.ChatGPTDecontextualizer.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.tutorial.chatgpt\_decontextulizer.ChatGPTDecontextualizer
         | 
| 2 | 
            +
            ===============================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.tutorial.chatgpt_decontextulizer
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: ChatGPTDecontextualizer
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~ChatGPTDecontextualizer.__init__
         | 
| 17 | 
            +
                  ~ChatGPTDecontextualizer.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~ChatGPTDecontextualizer.global_config
         | 
| 28 | 
            +
                  ~ChatGPTDecontextualizer.input_name
         | 
| 29 | 
            +
                  ~ChatGPTDecontextualizer.name
         | 
| 30 | 
            +
                  ~ChatGPTDecontextualizer.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_post_editor.ChatGPTPostEditor.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.tutorial.chatgpt\_post\_editor.ChatGPTPostEditor
         | 
| 2 | 
            +
            ======================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.tutorial.chatgpt_post_editor
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: ChatGPTPostEditor
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~ChatGPTPostEditor.__init__
         | 
| 17 | 
            +
                  ~ChatGPTPostEditor.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~ChatGPTPostEditor.global_config
         | 
| 28 | 
            +
                  ~ChatGPTPostEditor.input_name
         | 
| 29 | 
            +
                  ~ChatGPTPostEditor.name
         | 
| 30 | 
            +
                  ~ChatGPTPostEditor.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_worthiness_filter.ChatGPTWorthinessFilter.rst
    ADDED
    
    | @@ -0,0 +1,33 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.tutorial.chatgpt\_worthiness\_filter.ChatGPTWorthinessFilter
         | 
| 2 | 
            +
            ==================================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.tutorial.chatgpt_worthiness_filter
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: ChatGPTWorthinessFilter
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~ChatGPTWorthinessFilter.__init__
         | 
| 17 | 
            +
                  ~ChatGPTWorthinessFilter.build_solver
         | 
| 18 | 
            +
                  ~ChatGPTWorthinessFilter.convert_checkworthy_output_to_labels
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
               
         | 
| 21 | 
            +
             | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               
         | 
| 24 | 
            +
               .. rubric:: Attributes
         | 
| 25 | 
            +
             | 
| 26 | 
            +
               .. autosummary::
         | 
| 27 | 
            +
               
         | 
| 28 | 
            +
                  ~ChatGPTWorthinessFilter.global_config
         | 
| 29 | 
            +
                  ~ChatGPTWorthinessFilter.input_name
         | 
| 30 | 
            +
                  ~ChatGPTWorthinessFilter.name
         | 
| 31 | 
            +
                  ~ChatGPTWorthinessFilter.output_name
         | 
| 32 | 
            +
               
         | 
| 33 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.tutorial.concat_response_regenerator.ConcatResponseRegenerator.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.tutorial.concat\_response\_regenerator.ConcatResponseRegenerator
         | 
| 2 | 
            +
            ======================================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.tutorial.concat_response_regenerator
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: ConcatResponseRegenerator
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~ConcatResponseRegenerator.__init__
         | 
| 17 | 
            +
                  ~ConcatResponseRegenerator.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~ConcatResponseRegenerator.global_config
         | 
| 28 | 
            +
                  ~ConcatResponseRegenerator.input_name
         | 
| 29 | 
            +
                  ~ConcatResponseRegenerator.name
         | 
| 30 | 
            +
                  ~ConcatResponseRegenerator.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.tutorial.search_engine_evidence_retriever.SearchEngineEvidenceRetriever.rst
    ADDED
    
    | @@ -0,0 +1,35 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.tutorial.search\_engine\_evidence\_retriever.SearchEngineEvidenceRetriever
         | 
| 2 | 
            +
            ================================================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.tutorial.search_engine_evidence_retriever
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: SearchEngineEvidenceRetriever
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~SearchEngineEvidenceRetriever.__init__
         | 
| 17 | 
            +
                  ~SearchEngineEvidenceRetriever.build_solver
         | 
| 18 | 
            +
                  ~SearchEngineEvidenceRetriever.collect_claim_url_list
         | 
| 19 | 
            +
                  ~SearchEngineEvidenceRetriever.generate_questions_as_query
         | 
| 20 | 
            +
                  ~SearchEngineEvidenceRetriever.search_evidence
         | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
             | 
| 24 | 
            +
               
         | 
| 25 | 
            +
               
         | 
| 26 | 
            +
               .. rubric:: Attributes
         | 
| 27 | 
            +
             | 
| 28 | 
            +
               .. autosummary::
         | 
| 29 | 
            +
               
         | 
| 30 | 
            +
                  ~SearchEngineEvidenceRetriever.global_config
         | 
| 31 | 
            +
                  ~SearchEngineEvidenceRetriever.input_name
         | 
| 32 | 
            +
                  ~SearchEngineEvidenceRetriever.name
         | 
| 33 | 
            +
                  ~SearchEngineEvidenceRetriever.output_name
         | 
| 34 | 
            +
               
         | 
| 35 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.tutorial.spacy_response_decomposer.SpacyResponseDecomposer.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.tutorial.spacy\_response\_decomposer.SpacyResponseDecomposer
         | 
| 2 | 
            +
            ==================================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.tutorial.spacy_response_decomposer
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: SpacyResponseDecomposer
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~SpacyResponseDecomposer.__init__
         | 
| 17 | 
            +
                  ~SpacyResponseDecomposer.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~SpacyResponseDecomposer.global_config
         | 
| 28 | 
            +
                  ~SpacyResponseDecomposer.input_name
         | 
| 29 | 
            +
                  ~SpacyResponseDecomposer.name
         | 
| 30 | 
            +
                  ~SpacyResponseDecomposer.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.webservice.factcheckgpt_cp.FactCheckGPTClaimProcessor.rst
    ADDED
    
    | @@ -0,0 +1,32 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.webservice.factcheckgpt\_cp.FactCheckGPTClaimProcessor
         | 
| 2 | 
            +
            ============================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.webservice.factcheckgpt_cp
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: FactCheckGPTClaimProcessor
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~FactCheckGPTClaimProcessor.__init__
         | 
| 17 | 
            +
                  ~FactCheckGPTClaimProcessor.build_solver
         | 
| 18 | 
            +
               
         | 
| 19 | 
            +
               
         | 
| 20 | 
            +
             | 
| 21 | 
            +
               
         | 
| 22 | 
            +
               
         | 
| 23 | 
            +
               .. rubric:: Attributes
         | 
| 24 | 
            +
             | 
| 25 | 
            +
               .. autosummary::
         | 
| 26 | 
            +
               
         | 
| 27 | 
            +
                  ~FactCheckGPTClaimProcessor.global_config
         | 
| 28 | 
            +
                  ~FactCheckGPTClaimProcessor.input_name
         | 
| 29 | 
            +
                  ~FactCheckGPTClaimProcessor.name
         | 
| 30 | 
            +
                  ~FactCheckGPTClaimProcessor.output_name
         | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
    	
        docs/src/reference/api/openfactcheck.solvers.webservice.factcheckgpt_rtv.FactCheckGPTRetriever.rst
    ADDED
    
    | @@ -0,0 +1,42 @@ | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
            +
            openfactcheck.solvers.webservice.factcheckgpt\_rtv.FactCheckGPTRetriever
         | 
| 2 | 
            +
            ========================================================================
         | 
| 3 | 
            +
             | 
| 4 | 
            +
            .. currentmodule:: openfactcheck.solvers.webservice.factcheckgpt_rtv
         | 
| 5 | 
            +
             | 
| 6 | 
            +
            .. autoclass:: FactCheckGPTRetriever
         | 
| 7 | 
            +
             | 
| 8 | 
            +
               
         | 
| 9 | 
            +
               .. automethod:: __init__
         | 
| 10 | 
            +
             | 
| 11 | 
            +
               
         | 
| 12 | 
            +
               .. rubric:: Methods
         | 
| 13 | 
            +
             | 
| 14 | 
            +
               .. autosummary::
         | 
| 15 | 
            +
               
         | 
| 16 | 
            +
                  ~FactCheckGPTRetriever.__init__
         | 
| 17 | 
            +
                  ~FactCheckGPTRetriever.build_solver
         | 
| 18 | 
            +
                  ~FactCheckGPTRetriever.chunk_text
         | 
| 19 | 
            +
                  ~FactCheckGPTRetriever.generate_questions
         | 
| 20 | 
            +
                  ~FactCheckGPTRetriever.get_relevant_snippets
         | 
| 21 | 
            +
                  ~FactCheckGPTRetriever.get_web_evidences_for_claim
         | 
| 22 | 
            +
                  ~FactCheckGPTRetriever.is_tag_visible
         | 
| 23 | 
            +
                  ~FactCheckGPTRetriever.remove_duplicate_questions
         | 
| 24 | 
            +
                  ~FactCheckGPTRetriever.retrieve_documents
         | 
| 25 | 
            +
                  ~FactCheckGPTRetriever.run_question_generation
         | 
| 26 | 
            +
                  ~FactCheckGPTRetriever.scrape_url
         | 
| 27 | 
            +
                  ~FactCheckGPTRetriever.search_google
         | 
| 28 | 
            +
               
         | 
| 29 | 
            +
               
         | 
| 30 | 
            +
             | 
| 31 | 
            +
               
         | 
| 32 | 
            +
               
         | 
| 33 | 
            +
               .. rubric:: Attributes
         | 
| 34 | 
            +
             | 
| 35 | 
            +
               .. autosummary::
         | 
| 36 | 
            +
               
         | 
| 37 | 
            +
                  ~FactCheckGPTRetriever.global_config
         | 
| 38 | 
            +
                  ~FactCheckGPTRetriever.input_name
         | 
| 39 | 
            +
                  ~FactCheckGPTRetriever.name
         | 
| 40 | 
            +
                  ~FactCheckGPTRetriever.output_name
         | 
| 41 | 
            +
               
         | 
| 42 | 
            +
               
         |