Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[JS] Experiment Name Retry on Conflict #939

Merged
merged 6 commits into from
Aug 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 30 additions & 5 deletions js/src/evaluation/_runner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
RunEvaluator,
runEvaluator,
} from "./evaluator.js";
import { LangSmithConflictError } from "../utils/error.js";
import { v4 as uuidv4 } from "uuid";

// eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand Down Expand Up @@ -140,7 +141,7 @@ interface ExperimentResultRow {
* Supports lazily running predictions and evaluations in parallel to facilitate
* result streaming and early debugging.
*/
class _ExperimentManager {
export class _ExperimentManager {
_data?: DataT;

_runs?: AsyncGenerator<Run>;
Expand Down Expand Up @@ -312,17 +313,41 @@ class _ExperimentManager {
return projectMetadata;
}

async _getProject(firstExample: Example): Promise<TracerSession> {
async _createProject(firstExample: Example, projectMetadata: KVMap) {
// Create the project, updating the experimentName until we find a unique one.
let project: TracerSession;
if (!this._experiment) {
const originalExperimentName = this._experimentName;
for (let i = 0; i < 10; i++) {
try {
const projectMetadata = await this._getExperimentMetadata();
project = await this.client.createProject({
projectName: this.experimentName,
projectName: this._experimentName,
referenceDatasetId: firstExample.dataset_id,
metadata: projectMetadata,
description: this._description,
});
return project;
} catch (e) {
// Naming collision
if ((e as LangSmithConflictError)?.name === "LangSmithConflictError") {
const ent = uuidv4().slice(0, 6);
this._experimentName = `${originalExperimentName}-${ent}`;
} else {
throw e;
}
}
}
throw new Error(
"Could not generate a unique experiment name within 10 attempts." +
" Please try again with a different name."
);
}

async _getProject(firstExample: Example): Promise<TracerSession> {
let project: TracerSession;
if (!this._experiment) {
try {
const projectMetadata = await this._getExperimentMetadata();
project = await this._createProject(firstExample, projectMetadata);
this._experiment = project;
} catch (e) {
if (String(e).includes("already exists")) {
Expand Down
3 changes: 2 additions & 1 deletion js/src/tests/evaluate_comparative.int.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ import { evaluate } from "../evaluation/_runner.js";
import { evaluateComparative } from "../evaluation/evaluate_comparative.js";
import { Client } from "../index.js";
import { waitUntilRunFound } from "./utils.js";
import { v4 as uuidv4 } from "uuid";

const TESTING_DATASET_NAME = "test_evaluate_comparative_js";
const TESTING_DATASET_NAME = `test_evaluate_comparative_js_${uuidv4()}`;

beforeAll(async () => {
const client = new Client();
Expand Down
45 changes: 45 additions & 0 deletions js/src/tests/experiment_manager.int.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import { _ExperimentManager } from "../evaluation/_runner.js";
import { Client } from "../index.js";
import { v4 as uuidv4 } from "uuid";

const TESTING_DATASET_NAME = `test_experiment_manager_${uuidv4()}`;

beforeAll(async () => {
const client = new Client();

if (!(await client.hasDataset({ datasetName: TESTING_DATASET_NAME }))) {
await client.createDataset(TESTING_DATASET_NAME, {
description: "For testing pruposes",
});

await client.createExamples({
inputs: [{ input: 1 }, { input: 2 }],
outputs: [{ output: 2 }, { output: 3 }],
datasetName: TESTING_DATASET_NAME,
});
}
});

afterAll(async () => {
const client = new Client();
await client.deleteDataset({ datasetName: TESTING_DATASET_NAME });
});

describe("experiment manager", () => {
test("can recover from collisions", async () => {
const client = new Client();
const ds = await client.readDataset({ datasetName: TESTING_DATASET_NAME });
const manager = await new _ExperimentManager({
data: TESTING_DATASET_NAME,
client,
numRepetitions: 1,
});
const experimentName = manager._experimentName;
await client.createProject({
projectName: experimentName,
referenceDatasetId: ds.id,
});
await manager.start();
expect(manager._experimentName).not.toEqual(experimentName);
});
});
Loading