diff --git a/.gitignore b/.gitignore index d571cf401c9e07cb9ef0755aa9168bb9c8da1549..0b668843ec35929631ac28bfa0aded6302daf00b 100644 --- a/.gitignore +++ b/.gitignore @@ -29,4 +29,7 @@ dist/ passage.json questions.txt verification_error.txt -error_output.txt \ No newline at end of file +error_output.txt + +# Doc Specific +**/reference/api/* \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.FactCheckerState.rst b/docs/src/reference/api/openfactcheck.FactCheckerState.rst deleted file mode 100644 index 62549cb7dd0a221601d01cba0fbba52769b8bd6d..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.FactCheckerState.rst +++ /dev/null @@ -1,25 +0,0 @@ -openfactcheck.FactCheckerState -============================== - -.. currentmodule:: openfactcheck - -.. autoclass:: FactCheckerState - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactCheckerState.__init__ - ~FactCheckerState.get - ~FactCheckerState.set - ~FactCheckerState.to_dict - - - - - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.OpenFactCheck.rst b/docs/src/reference/api/openfactcheck.OpenFactCheck.rst deleted file mode 100644 index 79c08092f8084612a1d3a6731d6210b10e7fae4b..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.OpenFactCheck.rst +++ /dev/null @@ -1,39 +0,0 @@ -openfactcheck.OpenFactCheck -=========================== - -.. currentmodule:: openfactcheck - -.. autoclass:: OpenFactCheck - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~OpenFactCheck.__init__ - ~OpenFactCheck.init_pipeline - ~OpenFactCheck.init_pipeline_manually - ~OpenFactCheck.init_solver - ~OpenFactCheck.init_solvers - ~OpenFactCheck.list_claimprocessors - ~OpenFactCheck.list_retrievers - ~OpenFactCheck.list_solvers - ~OpenFactCheck.list_verifiers - ~OpenFactCheck.load_solvers - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~OpenFactCheck.FactCheckerEvaluator - ~OpenFactCheck.LLMEvaluator - ~OpenFactCheck.ResponseEvaluator - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.Solver.rst b/docs/src/reference/api/openfactcheck.Solver.rst deleted file mode 100644 index 4e3e838e6ee4c3359f6035d4017867a03c333137..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.Solver.rst +++ /dev/null @@ -1,26 +0,0 @@ -openfactcheck.Solver -==================== - -.. currentmodule:: openfactcheck - -.. autoclass:: Solver - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Solver.__init__ - ~Solver.load - ~Solver.load_from_directory - ~Solver.load_from_file - ~Solver.register - - - - - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.StandardTaskSolver.rst b/docs/src/reference/api/openfactcheck.StandardTaskSolver.rst deleted file mode 100644 index 22421505d31ef16a7c5f2e4beaff64a4af9b7f13..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.StandardTaskSolver.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.StandardTaskSolver -================================ - -.. currentmodule:: openfactcheck - -.. autoclass:: StandardTaskSolver - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~StandardTaskSolver.__init__ - ~StandardTaskSolver.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~StandardTaskSolver.global_config - ~StandardTaskSolver.input_name - ~StandardTaskSolver.name - ~StandardTaskSolver.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.errors.ConfigError.rst b/docs/src/reference/api/openfactcheck.errors.ConfigError.rst deleted file mode 100644 index 10952fbfddc6505ccf4eec737bc60210f734bc36..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.errors.ConfigError.rst +++ /dev/null @@ -1,6 +0,0 @@ -openfactcheck.errors.ConfigError -================================ - -.. currentmodule:: openfactcheck.errors - -.. autoexception:: ConfigError \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.errors.ConfigValidationError.rst b/docs/src/reference/api/openfactcheck.errors.ConfigValidationError.rst deleted file mode 100644 index 9fe1e07dee6b0f14e3e0cf409015161dbd2a4231..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.errors.ConfigValidationError.rst +++ /dev/null @@ -1,6 +0,0 @@ -openfactcheck.errors.ConfigValidationError -========================================== - -.. currentmodule:: openfactcheck.errors - -.. autoexception:: ConfigValidationError \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.evaluator.CheckerEvaluator.rst b/docs/src/reference/api/openfactcheck.evaluator.CheckerEvaluator.rst deleted file mode 100644 index 375bb84cabe61cfdfc9e01b13cad2a5a27f48fdb..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.evaluator.CheckerEvaluator.rst +++ /dev/null @@ -1,24 +0,0 @@ -openfactcheck.evaluator.CheckerEvaluator -======================================== - -.. currentmodule:: openfactcheck.evaluator - -.. autoclass:: CheckerEvaluator - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~CheckerEvaluator.__init__ - ~CheckerEvaluator.evaluate - ~CheckerEvaluator.evaluate_binary_classification - - - - - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.evaluator.LLMEvaluator.rst b/docs/src/reference/api/openfactcheck.evaluator.LLMEvaluator.rst deleted file mode 100644 index 640385688889be1271e49e57528df6bb07e56bd3..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.evaluator.LLMEvaluator.rst +++ /dev/null @@ -1,51 +0,0 @@ -openfactcheck.evaluator.LLMEvaluator -==================================== - -.. currentmodule:: openfactcheck.evaluator - -.. autoclass:: LLMEvaluator - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~LLMEvaluator.__init__ - ~LLMEvaluator.assess_freetext - ~LLMEvaluator.calculate_price - ~LLMEvaluator.call_fresheval - ~LLMEvaluator.call_openai_api - ~LLMEvaluator.cut_sentences - ~LLMEvaluator.cut_sub_string - ~LLMEvaluator.evaluate - ~LLMEvaluator.evaluate_freetext - ~LLMEvaluator.evaluate_freshqa - ~LLMEvaluator.evaluate_selfaware - ~LLMEvaluator.evaluate_snowballing - ~LLMEvaluator.extract_ratings - ~LLMEvaluator.filter_responses - ~LLMEvaluator.freetext_barplot - ~LLMEvaluator.freshqa_piechart - ~LLMEvaluator.generate_plots - ~LLMEvaluator.generate_report - ~LLMEvaluator.get_boolean - ~LLMEvaluator.get_unanswerable - ~LLMEvaluator.group_cosine_similarity - ~LLMEvaluator.read_evaluations - ~LLMEvaluator.read_input - ~LLMEvaluator.read_results - ~LLMEvaluator.remove_punctuation - ~LLMEvaluator.selfaware_barplot - ~LLMEvaluator.selfaware_cm - ~LLMEvaluator.snowballing_barplot - ~LLMEvaluator.snowballing_cm - ~LLMEvaluator.sum_all_elements - - - - - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.evaluator.ResponseEvaluator.rst b/docs/src/reference/api/openfactcheck.evaluator.ResponseEvaluator.rst deleted file mode 100644 index 61cf47cb22e3772c43aae48460ddc2ec255d42c7..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.evaluator.ResponseEvaluator.rst +++ /dev/null @@ -1,27 +0,0 @@ -openfactcheck.evaluator.ResponseEvaluator -========================================= - -.. currentmodule:: openfactcheck.evaluator - -.. autoclass:: ResponseEvaluator - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ResponseEvaluator.__init__ - ~ResponseEvaluator.evaluate - ~ResponseEvaluator.evaluate_streaming - ~ResponseEvaluator.persist_output - ~ResponseEvaluator.read_output - ~ResponseEvaluator.remove_output - - - - - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.lib.CustomFileLoggingFormatter.rst b/docs/src/reference/api/openfactcheck.lib.CustomFileLoggingFormatter.rst deleted file mode 100644 index 8d6527df0d1e7010650cee2a080f0ffd7f664c51..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.lib.CustomFileLoggingFormatter.rst +++ /dev/null @@ -1,37 +0,0 @@ -openfactcheck.lib.CustomFileLoggingFormatter -============================================ - -.. currentmodule:: openfactcheck.lib - -.. autoclass:: CustomFileLoggingFormatter - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~CustomFileLoggingFormatter.__init__ - ~CustomFileLoggingFormatter.converter - ~CustomFileLoggingFormatter.format - ~CustomFileLoggingFormatter.formatException - ~CustomFileLoggingFormatter.formatMessage - ~CustomFileLoggingFormatter.formatStack - ~CustomFileLoggingFormatter.formatTime - ~CustomFileLoggingFormatter.usesTime - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~CustomFileLoggingFormatter.default_msec_format - ~CustomFileLoggingFormatter.default_time_format - ~CustomFileLoggingFormatter.log_format - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.lib.CustomStreamLoggingFormatter.rst b/docs/src/reference/api/openfactcheck.lib.CustomStreamLoggingFormatter.rst deleted file mode 100644 index c35504f1f7d1059fdb6348ff695f8a669e6597c9..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.lib.CustomStreamLoggingFormatter.rst +++ /dev/null @@ -1,44 +0,0 @@ -openfactcheck.lib.CustomStreamLoggingFormatter -============================================== - -.. currentmodule:: openfactcheck.lib - -.. autoclass:: CustomStreamLoggingFormatter - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~CustomStreamLoggingFormatter.__init__ - ~CustomStreamLoggingFormatter.converter - ~CustomStreamLoggingFormatter.format - ~CustomStreamLoggingFormatter.formatException - ~CustomStreamLoggingFormatter.formatMessage - ~CustomStreamLoggingFormatter.formatStack - ~CustomStreamLoggingFormatter.formatTime - ~CustomStreamLoggingFormatter.usesTime - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~CustomStreamLoggingFormatter.FORMATS - ~CustomStreamLoggingFormatter.bold_red - ~CustomStreamLoggingFormatter.default_msec_format - ~CustomStreamLoggingFormatter.default_time_format - ~CustomStreamLoggingFormatter.green - ~CustomStreamLoggingFormatter.grey - ~CustomStreamLoggingFormatter.log_format - ~CustomStreamLoggingFormatter.red - ~CustomStreamLoggingFormatter.reset - ~CustomStreamLoggingFormatter.yellow - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.lib.OpenFactCheckConfig.rst b/docs/src/reference/api/openfactcheck.lib.OpenFactCheckConfig.rst deleted file mode 100644 index 58329a0828322c8aa8570d24bae84076bd47e71a..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.lib.OpenFactCheckConfig.rst +++ /dev/null @@ -1,24 +0,0 @@ -openfactcheck.lib.OpenFactCheckConfig -===================================== - -.. currentmodule:: openfactcheck.lib - -.. autoclass:: OpenFactCheckConfig - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~OpenFactCheckConfig.__init__ - ~OpenFactCheckConfig.solver_configuration - ~OpenFactCheckConfig.validate - - - - - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.lib.SolversConfig.rst b/docs/src/reference/api/openfactcheck.lib.SolversConfig.rst deleted file mode 100644 index f5a7299ac48e26d899c66a5805446e47daa46c58..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.lib.SolversConfig.rst +++ /dev/null @@ -1,23 +0,0 @@ -openfactcheck.lib.SolversConfig -=============================== - -.. currentmodule:: openfactcheck.lib - -.. autoclass:: SolversConfig - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~SolversConfig.__init__ - ~SolversConfig.load_config - - - - - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.lib.get_logger.rst b/docs/src/reference/api/openfactcheck.lib.get_logger.rst deleted file mode 100644 index 10c5d33bd59aa28c5a79ae83ef84198f04edaacc..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.lib.get_logger.rst +++ /dev/null @@ -1,6 +0,0 @@ -openfactcheck.lib.get\_logger -============================= - -.. currentmodule:: openfactcheck.lib - -.. autofunction:: get_logger \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.lib.set_logger_level.rst b/docs/src/reference/api/openfactcheck.lib.set_logger_level.rst deleted file mode 100644 index dee00abdf3d6b46ac68decdc22e39b1c1237c851..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.lib.set_logger_level.rst +++ /dev/null @@ -1,6 +0,0 @@ -openfactcheck.lib.set\_logger\_level -==================================== - -.. currentmodule:: openfactcheck.lib - -.. autofunction:: set_logger_level \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.dummy.confused_claim_examiner.ConfusedClaimExaminer.rst b/docs/src/reference/api/openfactcheck.solvers.dummy.confused_claim_examiner.ConfusedClaimExaminer.rst deleted file mode 100644 index 5d570e27840a3a0b37274807759b4e4cbc1176d2..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.dummy.confused_claim_examiner.ConfusedClaimExaminer.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.dummy.confused\_claim\_examiner.ConfusedClaimExaminer -=========================================================================== - -.. currentmodule:: openfactcheck.solvers.dummy.confused_claim_examiner - -.. autoclass:: ConfusedClaimExaminer - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ConfusedClaimExaminer.__init__ - ~ConfusedClaimExaminer.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ConfusedClaimExaminer.global_config - ~ConfusedClaimExaminer.input_name - ~ConfusedClaimExaminer.name - ~ConfusedClaimExaminer.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.dummy.fake_claim_extractor.FakeClaimExtractor.rst b/docs/src/reference/api/openfactcheck.solvers.dummy.fake_claim_extractor.FakeClaimExtractor.rst deleted file mode 100644 index 100d72b85e05805969cde3db65f391587d8af9a5..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.dummy.fake_claim_extractor.FakeClaimExtractor.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.dummy.fake\_claim\_extractor.FakeClaimExtractor -===================================================================== - -.. currentmodule:: openfactcheck.solvers.dummy.fake_claim_extractor - -.. autoclass:: FakeClaimExtractor - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FakeClaimExtractor.__init__ - ~FakeClaimExtractor.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FakeClaimExtractor.global_config - ~FakeClaimExtractor.input_name - ~FakeClaimExtractor.name - ~FakeClaimExtractor.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.dummy.ignorant_search_engine_retriever.IgnorantSearchEngineRetriever.rst b/docs/src/reference/api/openfactcheck.solvers.dummy.ignorant_search_engine_retriever.IgnorantSearchEngineRetriever.rst deleted file mode 100644 index 6ace15bedaeeff3b9d37d018b32c1085dfe16607..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.dummy.ignorant_search_engine_retriever.IgnorantSearchEngineRetriever.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.dummy.ignorant\_search\_engine\_retriever.IgnorantSearchEngineRetriever -============================================================================================= - -.. currentmodule:: openfactcheck.solvers.dummy.ignorant_search_engine_retriever - -.. autoclass:: IgnorantSearchEngineRetriever - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~IgnorantSearchEngineRetriever.__init__ - ~IgnorantSearchEngineRetriever.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~IgnorantSearchEngineRetriever.global_config - ~IgnorantSearchEngineRetriever.input_name - ~IgnorantSearchEngineRetriever.name - ~IgnorantSearchEngineRetriever.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.dummy.useless_response_regenerator.UselessResponseRegenerator.rst b/docs/src/reference/api/openfactcheck.solvers.dummy.useless_response_regenerator.UselessResponseRegenerator.rst deleted file mode 100644 index 8a93d0120e93512f90f14044c77e5906a3126f19..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.dummy.useless_response_regenerator.UselessResponseRegenerator.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.dummy.useless\_response\_regenerator.UselessResponseRegenerator -===================================================================================== - -.. currentmodule:: openfactcheck.solvers.dummy.useless_response_regenerator - -.. autoclass:: UselessResponseRegenerator - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~UselessResponseRegenerator.__init__ - ~UselessResponseRegenerator.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~UselessResponseRegenerator.global_config - ~UselessResponseRegenerator.input_name - ~UselessResponseRegenerator.name - ~UselessResponseRegenerator.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_cp.FactCheckGPTClaimProcessor.rst b/docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_cp.FactCheckGPTClaimProcessor.rst deleted file mode 100644 index a8588bf77f18f1e39c46c2b639814ef36f78ef5f..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_cp.FactCheckGPTClaimProcessor.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.factcheckgpt.factcheckgpt\_cp.FactCheckGPTClaimProcessor -============================================================================== - -.. currentmodule:: openfactcheck.solvers.factcheckgpt.factcheckgpt_cp - -.. autoclass:: FactCheckGPTClaimProcessor - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactCheckGPTClaimProcessor.__init__ - ~FactCheckGPTClaimProcessor.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactCheckGPTClaimProcessor.global_config - ~FactCheckGPTClaimProcessor.input_name - ~FactCheckGPTClaimProcessor.name - ~FactCheckGPTClaimProcessor.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_rtv.FactCheckGPTRetriever.rst b/docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_rtv.FactCheckGPTRetriever.rst deleted file mode 100644 index e467a7ac2dd09023194df9d13dc5bb16b8160c06..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_rtv.FactCheckGPTRetriever.rst +++ /dev/null @@ -1,42 +0,0 @@ -openfactcheck.solvers.factcheckgpt.factcheckgpt\_rtv.FactCheckGPTRetriever -========================================================================== - -.. currentmodule:: openfactcheck.solvers.factcheckgpt.factcheckgpt_rtv - -.. autoclass:: FactCheckGPTRetriever - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactCheckGPTRetriever.__init__ - ~FactCheckGPTRetriever.build_solver - ~FactCheckGPTRetriever.chunk_text - ~FactCheckGPTRetriever.generate_questions - ~FactCheckGPTRetriever.get_relevant_snippets - ~FactCheckGPTRetriever.get_web_evidences_for_claim - ~FactCheckGPTRetriever.is_tag_visible - ~FactCheckGPTRetriever.remove_duplicate_questions - ~FactCheckGPTRetriever.retrieve_documents - ~FactCheckGPTRetriever.run_question_generation - ~FactCheckGPTRetriever.scrape_url - ~FactCheckGPTRetriever.search_google - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactCheckGPTRetriever.global_config - ~FactCheckGPTRetriever.input_name - ~FactCheckGPTRetriever.name - ~FactCheckGPTRetriever.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_vfr.FactCheckGPTVerifier.rst b/docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_vfr.FactCheckGPTVerifier.rst deleted file mode 100644 index cc061ed90f2c7477724dafe5e6d0c645a753d76d..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.factcheckgpt.factcheckgpt_vfr.FactCheckGPTVerifier.rst +++ /dev/null @@ -1,36 +0,0 @@ -openfactcheck.solvers.factcheckgpt.factcheckgpt\_vfr.FactCheckGPTVerifier -========================================================================= - -.. currentmodule:: openfactcheck.solvers.factcheckgpt.factcheckgpt_vfr - -.. autoclass:: FactCheckGPTVerifier - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactCheckGPTVerifier.__init__ - ~FactCheckGPTVerifier.build_solver - ~FactCheckGPTVerifier.identify_stance_gpt - ~FactCheckGPTVerifier.stance - ~FactCheckGPTVerifier.verify_by_stance - ~FactCheckGPTVerifier.verify_claim - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactCheckGPTVerifier.global_config - ~FactCheckGPTVerifier.input_name - ~FactCheckGPTVerifier.name - ~FactCheckGPTVerifier.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.factool.all_pass_abstain_detector.AllPassAbstainDetector.rst b/docs/src/reference/api/openfactcheck.solvers.factool.all_pass_abstain_detector.AllPassAbstainDetector.rst deleted file mode 100644 index ca95e54d983f6f2258bdea74353652f016f87977..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.factool.all_pass_abstain_detector.AllPassAbstainDetector.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.factool.all\_pass\_abstain\_detector.AllPassAbstainDetector -================================================================================= - -.. currentmodule:: openfactcheck.solvers.factool.all_pass_abstain_detector - -.. autoclass:: AllPassAbstainDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~AllPassAbstainDetector.__init__ - ~AllPassAbstainDetector.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~AllPassAbstainDetector.global_config - ~AllPassAbstainDetector.input_name - ~AllPassAbstainDetector.name - ~AllPassAbstainDetector.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.factool.concat_response_regenerator.ConcatResponseRegenerator.rst b/docs/src/reference/api/openfactcheck.solvers.factool.concat_response_regenerator.ConcatResponseRegenerator.rst deleted file mode 100644 index 49dbbaf022b1dd852f31f01f8604d1e8ac1dbf32..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.factool.concat_response_regenerator.ConcatResponseRegenerator.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.factool.concat\_response\_regenerator.ConcatResponseRegenerator -===================================================================================== - -.. currentmodule:: openfactcheck.solvers.factool.concat_response_regenerator - -.. autoclass:: ConcatResponseRegenerator - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ConcatResponseRegenerator.__init__ - ~ConcatResponseRegenerator.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ConcatResponseRegenerator.global_config - ~ConcatResponseRegenerator.input_name - ~ConcatResponseRegenerator.name - ~ConcatResponseRegenerator.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.factool.factool_blackbox.FactoolBlackboxSolver.rst b/docs/src/reference/api/openfactcheck.solvers.factool.factool_blackbox.FactoolBlackboxSolver.rst deleted file mode 100644 index 068b76ea6ba6d1f421452ba92b39e64e72ec8917..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.factool.factool_blackbox.FactoolBlackboxSolver.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.factool.factool\_blackbox.FactoolBlackboxSolver -===================================================================== - -.. currentmodule:: openfactcheck.solvers.factool.factool_blackbox - -.. autoclass:: FactoolBlackboxSolver - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactoolBlackboxSolver.__init__ - ~FactoolBlackboxSolver.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactoolBlackboxSolver.global_config - ~FactoolBlackboxSolver.input_name - ~FactoolBlackboxSolver.name - ~FactoolBlackboxSolver.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.factool.factool_blackbox_post_editor.FactoolBlackboxPostEditor.rst b/docs/src/reference/api/openfactcheck.solvers.factool.factool_blackbox_post_editor.FactoolBlackboxPostEditor.rst deleted file mode 100644 index 7037c678f8749cc25bcfd3d0c8533424d868d2f9..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.factool.factool_blackbox_post_editor.FactoolBlackboxPostEditor.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.factool.factool\_blackbox\_post\_editor.FactoolBlackboxPostEditor -======================================================================================= - -.. currentmodule:: openfactcheck.solvers.factool.factool_blackbox_post_editor - -.. autoclass:: FactoolBlackboxPostEditor - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactoolBlackboxPostEditor.__init__ - ~FactoolBlackboxPostEditor.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactoolBlackboxPostEditor.global_config - ~FactoolBlackboxPostEditor.input_name - ~FactoolBlackboxPostEditor.name - ~FactoolBlackboxPostEditor.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.factool.factool_claim_examiner.FactoolClaimExaminer.rst b/docs/src/reference/api/openfactcheck.solvers.factool.factool_claim_examiner.FactoolClaimExaminer.rst deleted file mode 100644 index 14d891aa07aafddd82c83c6836289bca93ed249c..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.factool.factool_claim_examiner.FactoolClaimExaminer.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.factool.factool\_claim\_examiner.FactoolClaimExaminer -=========================================================================== - -.. currentmodule:: openfactcheck.solvers.factool.factool_claim_examiner - -.. autoclass:: FactoolClaimExaminer - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactoolClaimExaminer.__init__ - ~FactoolClaimExaminer.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactoolClaimExaminer.global_config - ~FactoolClaimExaminer.input_name - ~FactoolClaimExaminer.name - ~FactoolClaimExaminer.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.factool.factool_decontextualizer.FactoolDecontextualizer.rst b/docs/src/reference/api/openfactcheck.solvers.factool.factool_decontextualizer.FactoolDecontextualizer.rst deleted file mode 100644 index ef4276210947a4821459a8ac947416f573cb9852..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.factool.factool_decontextualizer.FactoolDecontextualizer.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.factool.factool\_decontextualizer.FactoolDecontextualizer -=============================================================================== - -.. currentmodule:: openfactcheck.solvers.factool.factool_decontextualizer - -.. autoclass:: FactoolDecontextualizer - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactoolDecontextualizer.__init__ - ~FactoolDecontextualizer.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactoolDecontextualizer.global_config - ~FactoolDecontextualizer.input_name - ~FactoolDecontextualizer.name - ~FactoolDecontextualizer.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.factool.factool_evidence_retriever.FactoolEvidenceRetriever.rst b/docs/src/reference/api/openfactcheck.solvers.factool.factool_evidence_retriever.FactoolEvidenceRetriever.rst deleted file mode 100644 index b772932bd8d479be83fa0ef7e2327341e7113504..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.factool.factool_evidence_retriever.FactoolEvidenceRetriever.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.factool.factool\_evidence\_retriever.FactoolEvidenceRetriever -=================================================================================== - -.. currentmodule:: openfactcheck.solvers.factool.factool_evidence_retriever - -.. autoclass:: FactoolEvidenceRetriever - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactoolEvidenceRetriever.__init__ - ~FactoolEvidenceRetriever.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactoolEvidenceRetriever.global_config - ~FactoolEvidenceRetriever.input_name - ~FactoolEvidenceRetriever.name - ~FactoolEvidenceRetriever.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.factool.factool_post_editor.FactoolPostEditor.rst b/docs/src/reference/api/openfactcheck.solvers.factool.factool_post_editor.FactoolPostEditor.rst deleted file mode 100644 index cabe3e7a55c1cd651e74813fa2a311121a250e6a..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.factool.factool_post_editor.FactoolPostEditor.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.factool.factool\_post\_editor.FactoolPostEditor -===================================================================== - -.. currentmodule:: openfactcheck.solvers.factool.factool_post_editor - -.. autoclass:: FactoolPostEditor - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactoolPostEditor.__init__ - ~FactoolPostEditor.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactoolPostEditor.global_config - ~FactoolPostEditor.input_name - ~FactoolPostEditor.name - ~FactoolPostEditor.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_agreement_gate.RARRAgreementGate.rst b/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_agreement_gate.RARRAgreementGate.rst deleted file mode 100644 index 36874072417ad9b308e8f3256c653f279ef948c4..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_agreement_gate.RARRAgreementGate.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.rarr.rarr\_agreement\_gate.RARRAgreementGate -================================================================== - -.. currentmodule:: openfactcheck.solvers.rarr.rarr_agreement_gate - -.. autoclass:: RARRAgreementGate - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~RARRAgreementGate.__init__ - ~RARRAgreementGate.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~RARRAgreementGate.global_config - ~RARRAgreementGate.input_name - ~RARRAgreementGate.name - ~RARRAgreementGate.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_concat_response_regenerator.RARRConcatResponseRegenerator.rst b/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_concat_response_regenerator.RARRConcatResponseRegenerator.rst deleted file mode 100644 index 338894e45e2851c3dd3dc12c1b869e5d4a77c30a..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_concat_response_regenerator.RARRConcatResponseRegenerator.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.rarr.rarr\_concat\_response\_regenerator.RARRConcatResponseRegenerator -============================================================================================ - -.. currentmodule:: openfactcheck.solvers.rarr.rarr_concat_response_regenerator - -.. autoclass:: RARRConcatResponseRegenerator - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~RARRConcatResponseRegenerator.__init__ - ~RARRConcatResponseRegenerator.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~RARRConcatResponseRegenerator.global_config - ~RARRConcatResponseRegenerator.input_name - ~RARRConcatResponseRegenerator.name - ~RARRConcatResponseRegenerator.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_editor.RARREditor.rst b/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_editor.RARREditor.rst deleted file mode 100644 index 32a4d907625609ffa4fe6e45aee2e92ff76f79df..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_editor.RARREditor.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.rarr.rarr\_editor.RARREditor -================================================== - -.. currentmodule:: openfactcheck.solvers.rarr.rarr_editor - -.. autoclass:: RARREditor - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~RARREditor.__init__ - ~RARREditor.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~RARREditor.global_config - ~RARREditor.input_name - ~RARREditor.name - ~RARREditor.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_llm_retriever.RARRLLMRetriever.rst b/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_llm_retriever.RARRLLMRetriever.rst deleted file mode 100644 index 41b8572cf6e03825c5f0e4b01b105a744534ace6..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_llm_retriever.RARRLLMRetriever.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.rarr.rarr\_llm\_retriever.RARRLLMRetriever -================================================================ - -.. currentmodule:: openfactcheck.solvers.rarr.rarr_llm_retriever - -.. autoclass:: RARRLLMRetriever - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~RARRLLMRetriever.__init__ - ~RARRLLMRetriever.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~RARRLLMRetriever.global_config - ~RARRLLMRetriever.input_name - ~RARRLLMRetriever.name - ~RARRLLMRetriever.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_question_generator.RARRQuestionGenerator.rst b/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_question_generator.RARRQuestionGenerator.rst deleted file mode 100644 index 8f9ff5e56313bdf8d669e929574b99bb171d529c..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_question_generator.RARRQuestionGenerator.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.rarr.rarr\_question\_generator.RARRQuestionGenerator -========================================================================== - -.. currentmodule:: openfactcheck.solvers.rarr.rarr_question_generator - -.. autoclass:: RARRQuestionGenerator - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~RARRQuestionGenerator.__init__ - ~RARRQuestionGenerator.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~RARRQuestionGenerator.global_config - ~RARRQuestionGenerator.input_name - ~RARRQuestionGenerator.name - ~RARRQuestionGenerator.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_search_engine_retriever.RARRSearchEngineRetriever.rst b/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_search_engine_retriever.RARRSearchEngineRetriever.rst deleted file mode 100644 index 8b3a28daf9fdd78b3fb8bb57a54aad6e614134bf..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.rarr.rarr_search_engine_retriever.RARRSearchEngineRetriever.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.rarr.rarr\_search\_engine\_retriever.RARRSearchEngineRetriever -==================================================================================== - -.. currentmodule:: openfactcheck.solvers.rarr.rarr_search_engine_retriever - -.. autoclass:: RARRSearchEngineRetriever - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~RARRSearchEngineRetriever.__init__ - ~RARRSearchEngineRetriever.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~RARRSearchEngineRetriever.global_config - ~RARRSearchEngineRetriever.input_name - ~RARRSearchEngineRetriever.name - ~RARRSearchEngineRetriever.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.tutorial.all_pass_abstain_detector.AllPassAbstainDetector.rst b/docs/src/reference/api/openfactcheck.solvers.tutorial.all_pass_abstain_detector.AllPassAbstainDetector.rst deleted file mode 100644 index 826669f39750261fe1953bcb28680fb27a1d2760..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.tutorial.all_pass_abstain_detector.AllPassAbstainDetector.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.tutorial.all\_pass\_abstain\_detector.AllPassAbstainDetector -================================================================================== - -.. currentmodule:: openfactcheck.solvers.tutorial.all_pass_abstain_detector - -.. autoclass:: AllPassAbstainDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~AllPassAbstainDetector.__init__ - ~AllPassAbstainDetector.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~AllPassAbstainDetector.global_config - ~AllPassAbstainDetector.input_name - ~AllPassAbstainDetector.name - ~AllPassAbstainDetector.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_decontextulizer.ChatGPTDecontextualizer.rst b/docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_decontextulizer.ChatGPTDecontextualizer.rst deleted file mode 100644 index 4e4b4113c4a5b398578f55ed38ba90266ea09b06..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_decontextulizer.ChatGPTDecontextualizer.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.tutorial.chatgpt\_decontextulizer.ChatGPTDecontextualizer -=============================================================================== - -.. currentmodule:: openfactcheck.solvers.tutorial.chatgpt_decontextulizer - -.. autoclass:: ChatGPTDecontextualizer - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ChatGPTDecontextualizer.__init__ - ~ChatGPTDecontextualizer.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ChatGPTDecontextualizer.global_config - ~ChatGPTDecontextualizer.input_name - ~ChatGPTDecontextualizer.name - ~ChatGPTDecontextualizer.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_post_editor.ChatGPTPostEditor.rst b/docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_post_editor.ChatGPTPostEditor.rst deleted file mode 100644 index 38b89e460f13a9ba8bc1fae12aeea5d109135edb..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_post_editor.ChatGPTPostEditor.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.tutorial.chatgpt\_post\_editor.ChatGPTPostEditor -====================================================================== - -.. currentmodule:: openfactcheck.solvers.tutorial.chatgpt_post_editor - -.. autoclass:: ChatGPTPostEditor - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ChatGPTPostEditor.__init__ - ~ChatGPTPostEditor.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ChatGPTPostEditor.global_config - ~ChatGPTPostEditor.input_name - ~ChatGPTPostEditor.name - ~ChatGPTPostEditor.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_worthiness_filter.ChatGPTWorthinessFilter.rst b/docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_worthiness_filter.ChatGPTWorthinessFilter.rst deleted file mode 100644 index 6b3b66f731d27760bed1ad1a908c51a6af46fcd8..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.tutorial.chatgpt_worthiness_filter.ChatGPTWorthinessFilter.rst +++ /dev/null @@ -1,33 +0,0 @@ -openfactcheck.solvers.tutorial.chatgpt\_worthiness\_filter.ChatGPTWorthinessFilter -================================================================================== - -.. currentmodule:: openfactcheck.solvers.tutorial.chatgpt_worthiness_filter - -.. autoclass:: ChatGPTWorthinessFilter - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ChatGPTWorthinessFilter.__init__ - ~ChatGPTWorthinessFilter.build_solver - ~ChatGPTWorthinessFilter.convert_checkworthy_output_to_labels - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ChatGPTWorthinessFilter.global_config - ~ChatGPTWorthinessFilter.input_name - ~ChatGPTWorthinessFilter.name - ~ChatGPTWorthinessFilter.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.tutorial.concat_response_regenerator.ConcatResponseRegenerator.rst b/docs/src/reference/api/openfactcheck.solvers.tutorial.concat_response_regenerator.ConcatResponseRegenerator.rst deleted file mode 100644 index 248ada0db4192abaf4c7f5d3a3cc11370bcea32a..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.tutorial.concat_response_regenerator.ConcatResponseRegenerator.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.tutorial.concat\_response\_regenerator.ConcatResponseRegenerator -====================================================================================== - -.. currentmodule:: openfactcheck.solvers.tutorial.concat_response_regenerator - -.. autoclass:: ConcatResponseRegenerator - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ConcatResponseRegenerator.__init__ - ~ConcatResponseRegenerator.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ConcatResponseRegenerator.global_config - ~ConcatResponseRegenerator.input_name - ~ConcatResponseRegenerator.name - ~ConcatResponseRegenerator.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.tutorial.search_engine_evidence_retriever.SearchEngineEvidenceRetriever.rst b/docs/src/reference/api/openfactcheck.solvers.tutorial.search_engine_evidence_retriever.SearchEngineEvidenceRetriever.rst deleted file mode 100644 index d3d164d334cf2121949100e6894f6b8becf6932f..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.tutorial.search_engine_evidence_retriever.SearchEngineEvidenceRetriever.rst +++ /dev/null @@ -1,35 +0,0 @@ -openfactcheck.solvers.tutorial.search\_engine\_evidence\_retriever.SearchEngineEvidenceRetriever -================================================================================================ - -.. currentmodule:: openfactcheck.solvers.tutorial.search_engine_evidence_retriever - -.. autoclass:: SearchEngineEvidenceRetriever - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~SearchEngineEvidenceRetriever.__init__ - ~SearchEngineEvidenceRetriever.build_solver - ~SearchEngineEvidenceRetriever.collect_claim_url_list - ~SearchEngineEvidenceRetriever.generate_questions_as_query - ~SearchEngineEvidenceRetriever.search_evidence - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SearchEngineEvidenceRetriever.global_config - ~SearchEngineEvidenceRetriever.input_name - ~SearchEngineEvidenceRetriever.name - ~SearchEngineEvidenceRetriever.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.tutorial.spacy_response_decomposer.SpacyResponseDecomposer.rst b/docs/src/reference/api/openfactcheck.solvers.tutorial.spacy_response_decomposer.SpacyResponseDecomposer.rst deleted file mode 100644 index b523f8c5477c772de5bc7f2ca2d6b3d38bc8a8a7..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.tutorial.spacy_response_decomposer.SpacyResponseDecomposer.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.tutorial.spacy\_response\_decomposer.SpacyResponseDecomposer -================================================================================== - -.. currentmodule:: openfactcheck.solvers.tutorial.spacy_response_decomposer - -.. autoclass:: SpacyResponseDecomposer - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~SpacyResponseDecomposer.__init__ - ~SpacyResponseDecomposer.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SpacyResponseDecomposer.global_config - ~SpacyResponseDecomposer.input_name - ~SpacyResponseDecomposer.name - ~SpacyResponseDecomposer.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.webservice.factcheckgpt_cp.FactCheckGPTClaimProcessor.rst b/docs/src/reference/api/openfactcheck.solvers.webservice.factcheckgpt_cp.FactCheckGPTClaimProcessor.rst deleted file mode 100644 index a1ececf5014afd1f5cf64a231e90edd661e7f384..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.webservice.factcheckgpt_cp.FactCheckGPTClaimProcessor.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.webservice.factcheckgpt\_cp.FactCheckGPTClaimProcessor -============================================================================ - -.. currentmodule:: openfactcheck.solvers.webservice.factcheckgpt_cp - -.. autoclass:: FactCheckGPTClaimProcessor - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactCheckGPTClaimProcessor.__init__ - ~FactCheckGPTClaimProcessor.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactCheckGPTClaimProcessor.global_config - ~FactCheckGPTClaimProcessor.input_name - ~FactCheckGPTClaimProcessor.name - ~FactCheckGPTClaimProcessor.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.webservice.factcheckgpt_rtv.FactCheckGPTRetriever.rst b/docs/src/reference/api/openfactcheck.solvers.webservice.factcheckgpt_rtv.FactCheckGPTRetriever.rst deleted file mode 100644 index 97df97e87d3e5578795b7dd43e354cf74963d601..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.webservice.factcheckgpt_rtv.FactCheckGPTRetriever.rst +++ /dev/null @@ -1,42 +0,0 @@ -openfactcheck.solvers.webservice.factcheckgpt\_rtv.FactCheckGPTRetriever -======================================================================== - -.. currentmodule:: openfactcheck.solvers.webservice.factcheckgpt_rtv - -.. autoclass:: FactCheckGPTRetriever - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactCheckGPTRetriever.__init__ - ~FactCheckGPTRetriever.build_solver - ~FactCheckGPTRetriever.chunk_text - ~FactCheckGPTRetriever.generate_questions - ~FactCheckGPTRetriever.get_relevant_snippets - ~FactCheckGPTRetriever.get_web_evidences_for_claim - ~FactCheckGPTRetriever.is_tag_visible - ~FactCheckGPTRetriever.remove_duplicate_questions - ~FactCheckGPTRetriever.retrieve_documents - ~FactCheckGPTRetriever.run_question_generation - ~FactCheckGPTRetriever.scrape_url - ~FactCheckGPTRetriever.search_google - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactCheckGPTRetriever.global_config - ~FactCheckGPTRetriever.input_name - ~FactCheckGPTRetriever.name - ~FactCheckGPTRetriever.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.webservice.factcheckgpt_vfr.FactCheckGPTVerifier.rst b/docs/src/reference/api/openfactcheck.solvers.webservice.factcheckgpt_vfr.FactCheckGPTVerifier.rst deleted file mode 100644 index a12907591c036a895bb36b2ed0ca4e8e25352fba..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.webservice.factcheckgpt_vfr.FactCheckGPTVerifier.rst +++ /dev/null @@ -1,36 +0,0 @@ -openfactcheck.solvers.webservice.factcheckgpt\_vfr.FactCheckGPTVerifier -======================================================================= - -.. currentmodule:: openfactcheck.solvers.webservice.factcheckgpt_vfr - -.. autoclass:: FactCheckGPTVerifier - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactCheckGPTVerifier.__init__ - ~FactCheckGPTVerifier.build_solver - ~FactCheckGPTVerifier.identify_stance_gpt - ~FactCheckGPTVerifier.stance - ~FactCheckGPTVerifier.verify_by_stance - ~FactCheckGPTVerifier.verify_claim - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactCheckGPTVerifier.global_config - ~FactCheckGPTVerifier.input_name - ~FactCheckGPTVerifier.name - ~FactCheckGPTVerifier.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.webservice.ftool_cp.FactoolClaimProcessor.rst b/docs/src/reference/api/openfactcheck.solvers.webservice.ftool_cp.FactoolClaimProcessor.rst deleted file mode 100644 index 7f6a6539ae7be381154c7af8701e954047d1717e..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.webservice.ftool_cp.FactoolClaimProcessor.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.webservice.ftool\_cp.FactoolClaimProcessor -================================================================ - -.. currentmodule:: openfactcheck.solvers.webservice.ftool_cp - -.. autoclass:: FactoolClaimProcessor - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactoolClaimProcessor.__init__ - ~FactoolClaimProcessor.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactoolClaimProcessor.global_config - ~FactoolClaimProcessor.input_name - ~FactoolClaimProcessor.name - ~FactoolClaimProcessor.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.webservice.ftool_rtv.FactoolRetriever.rst b/docs/src/reference/api/openfactcheck.solvers.webservice.ftool_rtv.FactoolRetriever.rst deleted file mode 100644 index 02ba4cc1a547130309a41d12146ed78d835ae9b2..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.webservice.ftool_rtv.FactoolRetriever.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.webservice.ftool\_rtv.FactoolRetriever -============================================================ - -.. currentmodule:: openfactcheck.solvers.webservice.ftool_rtv - -.. autoclass:: FactoolRetriever - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactoolRetriever.__init__ - ~FactoolRetriever.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactoolRetriever.global_config - ~FactoolRetriever.input_name - ~FactoolRetriever.name - ~FactoolRetriever.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.webservice.ftool_vfr.FactoolVerifier.rst b/docs/src/reference/api/openfactcheck.solvers.webservice.ftool_vfr.FactoolVerifier.rst deleted file mode 100644 index c09a88dd610f9ee309e023fc7c6b2c0e5738a736..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.webservice.ftool_vfr.FactoolVerifier.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.webservice.ftool\_vfr.FactoolVerifier -=========================================================== - -.. currentmodule:: openfactcheck.solvers.webservice.ftool_vfr - -.. autoclass:: FactoolVerifier - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FactoolVerifier.__init__ - ~FactoolVerifier.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FactoolVerifier.global_config - ~FactoolVerifier.input_name - ~FactoolVerifier.name - ~FactoolVerifier.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.webservice.rarr_rtv.RARRRetriever.rst b/docs/src/reference/api/openfactcheck.solvers.webservice.rarr_rtv.RARRRetriever.rst deleted file mode 100644 index 774eb5537e24600d20168e3f6428a2b9292178d9..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.webservice.rarr_rtv.RARRRetriever.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.webservice.rarr\_rtv.RARRRetriever -======================================================== - -.. currentmodule:: openfactcheck.solvers.webservice.rarr_rtv - -.. autoclass:: RARRRetriever - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~RARRRetriever.__init__ - ~RARRRetriever.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~RARRRetriever.global_config - ~RARRRetriever.input_name - ~RARRRetriever.name - ~RARRRetriever.output_name - - \ No newline at end of file diff --git a/docs/src/reference/api/openfactcheck.solvers.webservice.rarr_vfr.RARRAgreementGate.rst b/docs/src/reference/api/openfactcheck.solvers.webservice.rarr_vfr.RARRAgreementGate.rst deleted file mode 100644 index efcef8836901a8fa8e193780bf4c9a212edcf591..0000000000000000000000000000000000000000 --- a/docs/src/reference/api/openfactcheck.solvers.webservice.rarr_vfr.RARRAgreementGate.rst +++ /dev/null @@ -1,32 +0,0 @@ -openfactcheck.solvers.webservice.rarr\_vfr.RARRAgreementGate -============================================================ - -.. currentmodule:: openfactcheck.solvers.webservice.rarr_vfr - -.. autoclass:: RARRAgreementGate - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~RARRAgreementGate.__init__ - ~RARRAgreementGate.build_solver - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~RARRAgreementGate.global_config - ~RARRAgreementGate.input_name - ~RARRAgreementGate.name - ~RARRAgreementGate.output_name - - \ No newline at end of file