github-featured / comet-ml--opik

发布

0 发布 8,340 Git 标签

RSS 订阅源
  • 2.0.52-5503 635de169c3
    比较

    [OPIK-6542] [DOCS] docs: add opik migrate CLI documentation page (#6878)

    frostbyte_neo 发布于 2026-05-29 08:37:52 +00:00

    • [OPIK-6542] [DOCS] docs: add opik migrate CLI documentation page

    Add a public Fern docs page for the opik migrate CLI command covering
    both subcommands:

    • opik migrate dataset — what gets copied (version history, items,
      experiments, traces, spans, feedback scores, assertion results,
      comments, optimizations), what is not copied (prompt snapshots,
      attachments, thread-level fields), and the step-by-step plan.
    • opik migrate prompt — prompt and full version history with commit
      hashes preserved.

    Also documents the shared options, the --dry-run preview workflow
    (referenced from both subcommands), and common troubleshooting. Registers
    the page in the docs navigation under Observability.

    All commands, flags, the dry-run plan, and error messages were verified
    against a local Opik backend.

    Implements OPIK-6542: opik migrate dataset user-facing docs.

    Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com

    • docs(migrate): add Opik 1.0 -> 2.0 upgrade guide

    Add a Getting Started page explaining the 2.0 project-scoping change:
    what changed (datasets/prompts/experiments/optimizations/test suites are
    now scoped to a project), how to set project_name in both SDKs, where
    auto-migrated data landed (inferred project, else Default Project), a
    self-hosted section (auto-migration is off by default — move orphan data
    manually), and how to relocate data with the opik migrate CLI.

    Registers the page under Getting Started and adds a callout from the Home
    page. Cross-links to the Migrate data CLI page and the 2.0 changelog.

    • docs(migrate): recommend project_name on methods; refine data-landing + open-source notes
    • Recommend passing project_name to the create/search methods instead of the
      client constructor; note the env/config fallback to Default Project.
    • Rename 'Where your existing data went' -> 'lands'; 'While upgrading your
      workspace to 2.0'.
    • Drop the self-hosted section; add a short note that open-source workspaces
      are auto-promoted to 2.0 once blocking orphan data is migrated.
    • docs(migrate): cover project_name across all entity APIs in 2.0 upgrade guide

    Expand 'How to work now' into per-entity subsections (datasets, prompts,
    experiments, optimizations), each showing the relevant create/get/delete
    methods with project_name (projectName in TS). Note experiments follow
    their dataset's project under evaluate(), and optimizations are Python-only.

    • docs(migrate): clarify experiments always land in their dataset's project

    State that an experiment and all its traces, spans, and feedback scores
    land in the same project as the dataset it runs against (whether via
    evaluate or create_experiment); frame create_experiment's project_name as
    the dataset's project.

    • docs(migrate): drop the optimizations API section from the 2.0 upgrade guide

    create_optimization isn't called directly by users; remove the section
    and the optimization mention from the project_name intro.

    • docs(migrate): cover every CRUD-like project_name method per entity

    Expand the per-entity snippets to list all project-scoped CRUD methods:
    datasets (incl. get_dataset_experiments), test suites (new subsection),
    prompts (chat prompts, history, get_all, search), and experiment lookups
    (get_experiment_by_name / get_experiments_by_name). TS tabs show the
    methods that accept projectName.

    • docs(migrate): note that opik configure now prompts for a project

    • docs(migrate): address andrescrz review on 2.0 upgrade page

    • List the seven entities actually re-scoped under project (datasets,
      experiments, optimizations, prompts, automation rules, alerts,
      dashboards); drop traces/threads from the scoped list since they
      were already project-scoped in 1.x.
    • Call out the automation-rule single-project change and the
      workspace-level dashboards view that 2.0 retains.
    • Split the existing-data section into Opik Cloud (auto) and
      self-hosted (run migration jobs yourself); reference the upcoming
      self-host runbooks and the 2.0 release notes in the meantime.

    Co-authored-by: Claude Opus 4.7 (1M context) noreply@anthropic.com

    下载附件