DOCSEARCHbyAlgolia
Submit Docs

Evidently Documentation

repository·main·Indexed 27 days ago

https://github.com/evidentlyai/evidently

An open-source Python framework for evaluating, testing, and monitoring Machine Learning (ML) and Large Language Model (LLM) systems. It provides tools for tabular and text data, including offline Reports and Test Suites, a live Monitoring Dashboard, and specialized presets like TextEvals for LLM outputs and DataDriftPreset for detecting distribution shifts.

Tokens
11.8K
Snippets
24
Records
73
Agent score
92%

What's inside Evidently

  2. Set up local development for API documentation

    main

    To start a local development server with live reloading, run the local-dev.sh script. This serves the generated documentation at http://localhost:8080 (or the next available port) and automatically regenerates the documentation whenever Python files are changed.

    ./api-reference/local-dev.sh

  3. Initialize the Evidently database schema

    main

    Before running migrations, you may need to create the initial database schema. You can do this programmatically using SQLAlchemy and the Base model from Evidently's SQL storage models.

    from evidently.ui.service.storage.sql.models import Base
from sqlalchemy import create_engine

engine = create_engine("sqlite:///evidently.db")  # or your database URL
Base.metadata.create_all(engine)

  9. Run the Evidently UI with demo projects

    main
    To launch the Evidently Monitoring UI locally with pre-loaded demo projects, use the evidently ui command. If you use uv, you can run it without a manual environment setup. Otherwise, ensure you have installed evidently in your active virtual environment. The UI is accessible at localhost:8000.

  10. Configure VS Code for Biome

    main

    For the best development experience, use the biome vscode plugin. You can use the following .vscode/settings.json configuration to enable automatic formatting and import organization on save.

    {
  "editor.defaultFormatter": "biomejs.biome",
  "[javascript]": {
    "editor.defaultFormatter": "biomejs.biome"
  },
  "editor.formatOnSave": true,
  "biome.lspBin": "./ui/node_modules/@biomejs/biome/bin/biome",
  "biome.searchInPath": false,
  "editor.codeActionsOnSave":{
    "source.organizeImports.biome": "explicit"
  }
}