diff --git a/docs/latest/_autosummary/langfair.auto.auto.AutoEval.html b/docs/latest/_autosummary/langfair.auto.auto.AutoEval.html index 75469be..75e68e6 100644 --- a/docs/latest/_autosummary/langfair.auto.auto.AutoEval.html +++ b/docs/latest/_autosummary/langfair.auto.auto.AutoEval.html @@ -49,9 +49,11 @@ + + - + @@ -133,6 +135,40 @@ @@ -222,6 +258,40 @@ @@ -266,8 +336,96 @@ aria-label="Section Navigation">

Section Navigation

@@ -447,6 +614,24 @@

langfair.auto.auto.AutoEval
+ + +
+

previous

+

langfair.auto.auto

+
+ + +
+

next

+

langfair.constants

+
+ +
diff --git a/docs/latest/_autosummary/langfair.auto.auto.html b/docs/latest/_autosummary/langfair.auto.auto.html index 3a1a504..1def036 100644 --- a/docs/latest/_autosummary/langfair.auto.auto.html +++ b/docs/latest/_autosummary/langfair.auto.auto.html @@ -49,9 +49,11 @@ + + - + @@ -133,6 +135,40 @@

@@ -222,6 +258,40 @@ @@ -266,8 +336,96 @@ aria-label="Section Navigation">

Section Navigation

@@ -350,6 +514,24 @@ diff --git a/docs/latest/_autosummary/langfair.auto.html b/docs/latest/_autosummary/langfair.auto.html index bc8499b..1070be0 100644 --- a/docs/latest/_autosummary/langfair.auto.html +++ b/docs/latest/_autosummary/langfair.auto.html @@ -49,9 +49,11 @@ + + - + @@ -133,6 +135,40 @@
@@ -222,6 +258,40 @@ @@ -265,9 +335,97 @@ @@ -350,6 +511,24 @@ diff --git a/docs/latest/_autosummary/langfair.constants.cost_data.html b/docs/latest/_autosummary/langfair.constants.cost_data.html index 8821871..5b21534 100644 --- a/docs/latest/_autosummary/langfair.constants.cost_data.html +++ b/docs/latest/_autosummary/langfair.constants.cost_data.html @@ -49,9 +49,11 @@ + + - + @@ -133,6 +135,40 @@ @@ -222,6 +258,40 @@ @@ -266,8 +336,98 @@ aria-label="Section Navigation">

Section Navigation

@@ -308,6 +468,12 @@ + +
  • API
    • + + +
  • langfair.constants
    • +
  • langfair.constants.cost_data
    • @@ -340,6 +506,24 @@ diff --git a/docs/latest/_autosummary/langfair.constants.html b/docs/latest/_autosummary/langfair.constants.html index 736c5ad..2de3a51 100644 --- a/docs/latest/_autosummary/langfair.constants.html +++ b/docs/latest/_autosummary/langfair.constants.html @@ -49,9 +49,11 @@ + + - + @@ -133,6 +135,40 @@ @@ -222,6 +258,40 @@ @@ -265,9 +335,99 @@ @@ -308,6 +468,9 @@ + +
  • API
    • +
  • langfair.constants
    • @@ -351,6 +514,24 @@ diff --git a/docs/latest/_autosummary/langfair.constants.word_lists.html b/docs/latest/_autosummary/langfair.constants.word_lists.html index 2cd32f5..48495ac 100644 --- a/docs/latest/_autosummary/langfair.constants.word_lists.html +++ b/docs/latest/_autosummary/langfair.constants.word_lists.html @@ -49,9 +49,11 @@ + + - + @@ -133,6 +135,40 @@ @@ -222,6 +258,40 @@ @@ -266,8 +336,98 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -308,6 +468,12 @@ + +
  • API
    • + + +
  • langfair.constants
    • +
  • langfair.constants.word_lists
    • @@ -355,6 +521,24 @@ diff --git a/docs/latest/_autosummary/langfair.generator.counterfactual.CounterfactualGenerator.html b/docs/latest/_autosummary/langfair.generator.counterfactual.CounterfactualGenerator.html index 4cef24a..93172dc 100644 --- a/docs/latest/_autosummary/langfair.generator.counterfactual.CounterfactualGenerator.html +++ b/docs/latest/_autosummary/langfair.generator.counterfactual.CounterfactualGenerator.html @@ -49,9 +49,11 @@ + + - + @@ -133,6 +135,40 @@ @@ -222,6 +258,40 @@ @@ -266,12 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,12 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,12 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,12 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -265,13 +335,97 @@ @@ -357,6 +514,24 @@ diff --git a/docs/latest/_autosummary/langfair.metrics.classification.classification.ClassificationMetrics.html b/docs/latest/_autosummary/langfair.metrics.classification.classification.ClassificationMetrics.html index 5d15099..8bacff1 100644 --- a/docs/latest/_autosummary/langfair.metrics.classification.classification.ClassificationMetrics.html +++ b/docs/latest/_autosummary/langfair.metrics.classification.classification.ClassificationMetrics.html @@ -49,9 +49,11 @@ + + - + @@ -133,6 +135,40 @@ @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -265,126 +335,95 @@ @@ -481,6 +523,24 @@ diff --git a/docs/latest/_autosummary/langfair.metrics.recommendation.html b/docs/latest/_autosummary/langfair.metrics.recommendation.html index e387483..8f61fcc 100644 --- a/docs/latest/_autosummary/langfair.metrics.recommendation.html +++ b/docs/latest/_autosummary/langfair.metrics.recommendation.html @@ -49,9 +49,11 @@ + + - + @@ -133,6 +135,40 @@ @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,127 +336,96 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -222,6 +258,40 @@ @@ -266,125 +336,94 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -206,10 +242,8 @@ - - -
    +
    @@ -224,6 +258,40 @@
    @@ -262,6 +330,109 @@
    +
    +
    +
    +
    +
    @@ -345,6 +516,24 @@

    API#

    diff --git a/docs/latest/auto_examples/auto_eval_demo.html b/docs/latest/auto_examples/auto_eval_demo.html index 28c3b68..686af58 100644 --- a/docs/latest/auto_examples/auto_eval_demo.html +++ b/docs/latest/auto_examples/auto_eval_demo.html @@ -54,7 +54,7 @@ - + diff --git a/docs/latest/auto_examples/classification_metrics_demo.html b/docs/latest/auto_examples/classification_metrics_demo.html index 1c98db1..f2bd89c 100644 --- a/docs/latest/auto_examples/classification_metrics_demo.html +++ b/docs/latest/auto_examples/classification_metrics_demo.html @@ -53,7 +53,7 @@ - + diff --git a/docs/latest/auto_examples/counterfactual_metrics_demo.html b/docs/latest/auto_examples/counterfactual_metrics_demo.html index c0dd95d..5fd8dee 100644 --- a/docs/latest/auto_examples/counterfactual_metrics_demo.html +++ b/docs/latest/auto_examples/counterfactual_metrics_demo.html @@ -54,7 +54,7 @@ - + diff --git a/docs/latest/auto_examples/evaluations/index.html b/docs/latest/auto_examples/evaluations/index.html index 2457707..2fc7a73 100644 --- a/docs/latest/auto_examples/evaluations/index.html +++ b/docs/latest/auto_examples/evaluations/index.html @@ -51,7 +51,7 @@ - + @@ -133,6 +133,40 @@
    @@ -224,6 +258,40 @@
    diff --git a/docs/latest/auto_examples/evaluations/sg_execution_times.html b/docs/latest/auto_examples/evaluations/sg_execution_times.html index 2d6b836..9555aca 100644 --- a/docs/latest/auto_examples/evaluations/sg_execution_times.html +++ b/docs/latest/auto_examples/evaluations/sg_execution_times.html @@ -51,7 +51,7 @@ - + @@ -133,6 +133,40 @@ @@ -224,6 +258,40 @@ diff --git a/docs/latest/auto_examples/generators/index.html b/docs/latest/auto_examples/generators/index.html index fd27cbe..d06373f 100644 --- a/docs/latest/auto_examples/generators/index.html +++ b/docs/latest/auto_examples/generators/index.html @@ -51,7 +51,7 @@ - + @@ -133,6 +133,40 @@ @@ -224,6 +258,40 @@ diff --git a/docs/latest/auto_examples/generators/sg_execution_times.html b/docs/latest/auto_examples/generators/sg_execution_times.html index 47d280d..69c4c2f 100644 --- a/docs/latest/auto_examples/generators/sg_execution_times.html +++ b/docs/latest/auto_examples/generators/sg_execution_times.html @@ -51,7 +51,7 @@ - + @@ -133,6 +133,40 @@ @@ -224,6 +258,40 @@ diff --git a/docs/latest/auto_examples/index.html b/docs/latest/auto_examples/index.html index 65bfc50..622d80a 100644 --- a/docs/latest/auto_examples/index.html +++ b/docs/latest/auto_examples/index.html @@ -54,7 +54,7 @@ - + diff --git a/docs/latest/auto_examples/recommendation_metrics_demo.html b/docs/latest/auto_examples/recommendation_metrics_demo.html index 2f278e4..9e51ab5 100644 --- a/docs/latest/auto_examples/recommendation_metrics_demo.html +++ b/docs/latest/auto_examples/recommendation_metrics_demo.html @@ -54,7 +54,7 @@ - + diff --git a/docs/latest/auto_examples/response_generator_demo.html b/docs/latest/auto_examples/response_generator_demo.html index dfdf2a6..5007c6f 100644 --- a/docs/latest/auto_examples/response_generator_demo.html +++ b/docs/latest/auto_examples/response_generator_demo.html @@ -53,7 +53,7 @@ - + diff --git a/docs/latest/auto_examples/sg_execution_times.html b/docs/latest/auto_examples/sg_execution_times.html index 0c4daf4..ffa3316 100644 --- a/docs/latest/auto_examples/sg_execution_times.html +++ b/docs/latest/auto_examples/sg_execution_times.html @@ -51,7 +51,7 @@ - + @@ -133,6 +133,40 @@ @@ -224,6 +258,40 @@ diff --git a/docs/latest/auto_examples/stereotype_metrics_demo.html b/docs/latest/auto_examples/stereotype_metrics_demo.html index 2d83df4..f64428f 100644 --- a/docs/latest/auto_examples/stereotype_metrics_demo.html +++ b/docs/latest/auto_examples/stereotype_metrics_demo.html @@ -54,7 +54,7 @@ - + diff --git a/docs/latest/auto_examples/test-notebook.html b/docs/latest/auto_examples/test-notebook.html index 2c1cd1f..a9ed3a3 100644 --- a/docs/latest/auto_examples/test-notebook.html +++ b/docs/latest/auto_examples/test-notebook.html @@ -51,7 +51,7 @@ - + @@ -133,6 +133,40 @@ @@ -224,6 +258,40 @@ diff --git a/docs/latest/auto_examples/toxicity_metrics_demo.html b/docs/latest/auto_examples/toxicity_metrics_demo.html index 938fc7f..973b344 100644 --- a/docs/latest/auto_examples/toxicity_metrics_demo.html +++ b/docs/latest/auto_examples/toxicity_metrics_demo.html @@ -54,7 +54,7 @@ - + diff --git a/docs/latest/auto_examples/yyy-test.html b/docs/latest/auto_examples/yyy-test.html index bfecb4a..9057c5d 100644 --- a/docs/latest/auto_examples/yyy-test.html +++ b/docs/latest/auto_examples/yyy-test.html @@ -51,7 +51,7 @@ - + @@ -133,6 +133,40 @@ @@ -224,6 +258,40 @@ diff --git a/docs/latest/choosing_metrics.html b/docs/latest/choosing_metrics.html index ee44b7d..a349355 100644 --- a/docs/latest/choosing_metrics.html +++ b/docs/latest/choosing_metrics.html @@ -53,7 +53,7 @@ - + diff --git a/docs/latest/genindex.html b/docs/latest/genindex.html index d3f2966..ab8e11d 100644 --- a/docs/latest/genindex.html +++ b/docs/latest/genindex.html @@ -50,7 +50,7 @@ - + diff --git a/docs/latest/guide.html b/docs/latest/guide.html index 7b408a7..c465354 100644 --- a/docs/latest/guide.html +++ b/docs/latest/guide.html @@ -49,9 +49,10 @@ + - + @@ -133,6 +134,40 @@ @@ -206,10 +241,8 @@ - - -
    +
    @@ -224,6 +257,40 @@
    @@ -262,6 +329,15 @@
    +
    +
    +
    +
    +
    @@ -433,6 +509,15 @@

    Table of Contents
    + + +
    +

    previous

    +

    Counterfactual Metrics

    +
    +
    diff --git a/docs/latest/index.html b/docs/latest/index.html index 58ddaf1..f28c97e 100644 --- a/docs/latest/index.html +++ b/docs/latest/index.html @@ -53,7 +53,7 @@ - + @@ -366,7 +366,7 @@

    Welcome to LangFair’s documentation!Get Started → | View Examples →

    Why LangFair?#

    @@ -375,15 +375,14 @@

    Why LangFair?

    Featured Resources#

    +

    Check out our featured resources to help you get started with LangFair.

    -

    -

    @@ -224,6 +258,40 @@
    diff --git a/docs/latest/usage.html b/docs/latest/usage.html index e823a69..f0071a7 100644 --- a/docs/latest/usage.html +++ b/docs/latest/usage.html @@ -49,9 +49,11 @@ + + - + @@ -133,6 +135,40 @@ @@ -206,10 +242,8 @@ - - -
    +
    @@ -224,6 +258,40 @@
    @@ -262,6 +330,15 @@
    +
    +
    +
    +
    +
    @@ -461,6 +538,24 @@

    Alternative approach: Semi-automated evaluation with
    + + +
    +

    previous

    +

    Welcome to LangFair’s documentation!

    +
    +     + +
    +

    next

    +

    Choosing Metrics

    +
    + +
    diff --git a/docs_src/latest/source/index.rst b/docs_src/latest/source/index.rst index 2fbb661..cd6c6e9 100644 --- a/docs_src/latest/source/index.rst +++ b/docs_src/latest/source/index.rst @@ -14,7 +14,7 @@ LangFair is a comprehensive Python library designed for conducting use-case-spec 🔍 **Make Informed Decisions**: Use our framework to choose the right evaluation metrics -🛠️ **Simple Integration**: Easy-to-use Python interface for seamless implementation +🛠️ **Integrate with Workflows**: Easy-to-use Python interface for seamless implementation :doc:`Get Started → ` | :doc:`View Examples → ` @@ -29,12 +29,14 @@ LangFair addresses this gap by adopting a Bring Your Own Prompts (BYOP) approach Featured Resources ------------------ +Check out our featured resources to help you get started with LangFair. + - 🚀 :doc:`Get started ` in minutes - 🔬 Explore our :doc:`framework for choosing metrics ` - 💡 Try our :doc:`guided examples ` - 📖 Read the `research paper `_ -Quick Links + ----------- .. toctree::