Git Product home page Git Product logo

fennec's Introduction

Fennec

Fennec is a tool designed for automating the evaluation of conversational data, offering judgements across multiple dimensions and granularities.

Fennec aim is to address two key challenges:

  • Multidimensional Evaluation: providing comprehensive or accurate responses to multi-intent queries.
  • Scaling Evaluation Capabilities: extending evaluation abilities to encompass a wider array of scenarios and usage examples.

๐ŸŽซ Approach

Approach

Fennec provides a step-by-step framework designed for evaluating conversational responses using a Branching mechanism.

  1. Evaluation Criteria: Offers users multiple evaluation dimensions for their queries.
  2. Scoring Guidelines: Extends scoring rules (1-5 points) for each scoring dimension.
  3. Judgements: Scores based on evaluation criteria and scoring guidelines.
  4. Correction: Addresses issues identified within the conversations accordingly.

๐Ÿงฑ Available Resource

Model Parameters Datasets Agreement โฌ† Consistency โฌ†
GPT-4 - - 62.28 86.28
GPT-3.5 - - 42.74 62.43
Auto-J 13B Auto-J 54.96 83.41
Fennec 7B Fennec 56.63 86.32
Fennec 7B Fennec-bridging 57.40 87.00

๐Ÿงฉ Setup

  1. The current version has minimal third-party dependencies:

    pip install SQLAlchemy # Utilized for data caching.
    pip install scikit-learn # Employed for computing evaluation metrics.
    pip install loguru # logging functionalities.
  2. Fennec utilizes vLLM to launch inference services, currently supporting version >= 0.2.1.

    pip install vllm

    or build from source:

    git clone https://github.com/vllm-project/vllm.git
    cd vllm
    pip install -e .

๐ŸŽฎ Usage

Using Fennec involves two steps:

  1. Launching vLLM server for Fennec evaluation:

    python scripts/run_vllm_server.sh
    • EVAL_PARALLEL: allows for inference on multiple GPU resources concurrently when available.
    • MODEl_NAME: the address where the downloaded model is stored.
  2. Evaluating benchmark dataset (or custom dataset):

    python scripts/fennec_eval.sh

    -a -p {number}: execute parallel inference and specify the {number}.

We provide more detailed Recipes on how to use the current repo.

โ˜• More

fennec's People

Contributors

dropreg avatar banner-z avatar

Stargazers

 avatar  avatar  avatar Zak-Sing avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.