Create Fine-Tune Job with Lamini API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Lamini, Pipedream and 2,700+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Fine-Tune Job with the Lamini API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Pipedream trigger and Lamini action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Create Fine-Tune Job action
1. Connect your Lamini account
2. Select a Model Name
3. Configure Dataset ID
4. Optional- Configure Finetune Arguments
5. Optional- Configure GPU Config
6. Optional- Configure Is Public
7. Optional- Configure Custom Model Name
8. Optional- Configure Wait for Completion
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

Pipedream uses API keys for authentication. When you connect your Pipedream account, Pipedream securely stores the keys so you can easily authenticate to Pipedream APIs in both code and no-code steps.

About Pipedream#

Integration platform for developers

Action#

Create Fine-Tune Job on Lamini

Description:Create a fine-tuning job with a dataset. [See the documentation](https://docs.lamini.ai/api/).

Version:0.0.2

Key:lamini-create-fine-tune-job

View on GitHub

Action Code#

import app from "../../lamini.app.mjs";
import constants from "../../common/constants.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "lamini-create-fine-tune-job",
  name: "Create Fine-Tune Job",
  description: "Create a fine-tuning job with a dataset. [See the documentation](https://docs.lamini.ai/api/).",
  version: "0.0.2",
  type: "action",
  props: {
    app,
    modelName: {
      description: "Base model to be fine-tuned.",
      propDefinition: [
        app,
        "modelName",
        () => ({
          includeFineTunedModels: false,
        }),
      ],
    },
    datasetId: {
      type: "string",
      label: "Dataset ID",
      description: "Previously uploaded dataset to use for training. Please use the **Upload Dataset** action to upload a dataset.",
    },
    fineTuneArgs: {
      type: "object",
      label: "Finetune Arguments",
      description: "Optional hyperparameters for fine-tuning. Each property is optional:\n- `index_pq_m`: Number of subquantizers for PQ (eg. 8)\n- `index_max_size`: Maximum index size (eg. 65536)\n- `max_steps`: Maximum number of training steps (eg. 60)\n- `batch_size`: Training batch size (eg. 1)\n- `learning_rate`: Learning rate (eg. 0.0003)\n- `index_pq_nbits`: Number of bits per subquantizer (eg. 8)\n- `max_length`: Maximum sequence length (eg. 2048)\n- `index_ivf_nlist`: Number of IVF lists (eg. 2048)\n- `save_steps`: Steps between checkpoints (eg. 60)\n- `args_name`: Name for the argument set (eg. \"demo\")\n- `r_value`: R value for LoRA (eg. 32)\n- `index_hnsw_m`: Number of neighbors in HNSW (eg. 32)\n- `index_method`: Indexing method (eg. \"IndexIVFPQ\")\n- `optim`: Optimizer to use (eg. \"adafactor\")\n- `index_hnsw_efConstruction`: HNSW construction parameter (eg. 16)\n- `index_hnsw_efSearch`: HNSW search parameter (eg. 8)\n- `index_k`: Number of nearest neighbors (eg. 2)\n- `index_ivf_nprobe`: Number of IVF probes (eg. 48)\n- `eval_steps`: Steps between evaluations (eg. 30)\n[See the documentation](https://docs.lamini.ai/tuning/hyperparameters/#finetune_args).",
      optional: true,
    },
    gpuConfig: {
      type: "object",
      label: "GPU Config",
      description: "Optional GPU configuration for fine-tuning. [See the documentation](https://docs.lamini.ai/tuning/hyperparameters/#gpu_config).",
      optional: true,
    },
    isPublic: {
      type: "boolean",
      label: "Is Public",
      description: "Whether this fine-tuning job and dataset should be publicly accessible.",
      optional: true,
    },
    customModelName: {
      type: "string",
      label: "Custom Model Name",
      description: "A human-readable name for the fine-tuned model.",
      optional: true,
    },
    waitForCompletion: {
      type: "boolean",
      label: "Wait for Completion",
      description: "If set to `true`, the action will wait and poll until the fine-tuning job is `COMPLETED`. If is set to `false`, it will return immediately after creating the job.",
      default: false,
      optional: true,
    },
  },
  methods: {
    createFineTuneJob(args = {}) {
      return this.app.post({
        versionPath: constants.VERSION_PATH.V1,
        path: "/train",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      app,
      createFineTuneJob,
      modelName,
      datasetId,
      fineTuneArgs,
      gpuConfig,
      isPublic,
      customModelName,
      waitForCompletion,
    } = this;

    const MAX_RETRIES = 15;
    const DELAY = 1000 * 30; // 30 seconds
    const { run } = $.context;

    // First run: Create the fine-tune job
    if (run.runs === 1) {
      const { upload_base_path: uploadBasePath } =
        await app.getUploadBasePath({
          $,
        });

      await app.getExistingDataset({
        $,
        data: {
          dataset_id: datasetId,
          upload_base_path: uploadBasePath,
        },
      });

      const response = await createFineTuneJob({
        $,
        data: {
          model_name: modelName,
          dataset_id: datasetId,
          upload_file_path: `${uploadBasePath}/${datasetId}.jsonlines`,
          finetune_args: utils.parseJson(fineTuneArgs),
          gpu_config: utils.parseJson(gpuConfig),
          is_public: isPublic,
          custom_model_name: customModelName,
        },
      });

      $.export("$summary", `Successfully created a fine-tune job with ID \`${response.job_id}\`.`);

      // If user doesn't want to wait, return immediately
      if (!waitForCompletion) {
        return response;
      }

      // Store job_id for polling and start rerun
      $.flow.rerun(DELAY, {
        jobId: response.job_id,
      }, MAX_RETRIES);
      return response;
    }

    // Subsequent runs: Poll for job status
    if (run.runs > MAX_RETRIES) {
      throw new Error("Max retries exceeded - fine-tuning job may still be running");
    }

    const { jobId } = run.context;

    // Poll for status
    const statusResponse = await app.getJobStatus({
      $,
      jobId,
    });

    // If job is completed, return the final status
    if (statusResponse.status === "COMPLETED") {
      $.export("$summary", `Fine-tuning job \`${jobId}\` completed successfully.`);
      return statusResponse;
    }

    // If job failed, throw error
    if (statusResponse.status === "FAILED") {
      throw new Error(`Fine-tuning job \`${jobId}\` failed.`);
    }

    // Otherwise, continue polling
    $.flow.rerun(DELAY, {
      jobId,
    }, MAX_RETRIES);
    return {
      status: statusResponse.status,
      jobId,
      message: `Job is still running. Current status: ${statusResponse.status}`,
    };
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Lamini	`app`	`app`	This component uses the Lamini app.
Model Name	`modelName`	`string`	Select a value from the drop down menu.
Dataset ID	`datasetId`	`string`	Previously uploaded dataset to use for training. Please use the Upload Dataset action to upload a dataset.
Finetune Arguments	`fineTuneArgs`	`object`	Optional hyperparameters for fine-tuning. Each property is optional: `index_pq_m`: Number of subquantizers for PQ (eg. 8) `index_max_size`: Maximum index size (eg. 65536) `max_steps`: Maximum number of training steps (eg. 60) `batch_size`: Training batch size (eg. 1) `learning_rate`: Learning rate (eg. 0.0003) `index_pq_nbits`: Number of bits per subquantizer (eg. 8) `max_length`: Maximum sequence length (eg. 2048) `index_ivf_nlist`: Number of IVF lists (eg. 2048) `save_steps`: Steps between checkpoints (eg. 60) `args_name`: Name for the argument set (eg. "demo") `r_value`: R value for LoRA (eg. 32) `index_hnsw_m`: Number of neighbors in HNSW (eg. 32) `index_method`: Indexing method (eg. "IndexIVFPQ") `optim`: Optimizer to use (eg. "adafactor") `index_hnsw_efConstruction`: HNSW construction parameter (eg. 16) `index_hnsw_efSearch`: HNSW search parameter (eg. 8) `index_k`: Number of nearest neighbors (eg. 2) `index_ivf_nprobe`: Number of IVF probes (eg. 48) `eval_steps`: Steps between evaluations (eg. 30) See the documentation
GPU Config	`gpuConfig`	`object`	Optional GPU configuration for fine-tuning. See the documentation
Is Public	`isPublic`	`boolean`	Whether this fine-tuning job and dataset should be publicly accessible.
Custom Model Name	`customModelName`	`string`	A human-readable name for the fine-tuned model.
Wait for Completion	`waitForCompletion`	`boolean`	If set to `true`, the action will wait and poll until the fine-tuning job is `COMPLETED`. If is set to `false`, it will return immediately after creating the job.

Action Authentication#

Lamini uses API keys for authentication. When you connect your Lamini account, Pipedream securely stores the keys so you can easily authenticate to Lamini APIs in both code and no-code steps.

About Lamini#

Enterprise LLM Platform

More Ways to Connect Lamini + Pipedream#

Other Popular Integrations#

Generate Completion with Lamini API on New Scheduled Tasks from Pipedream API

Pipedream + Lamini

Create Fine-Tune Job with Lamini API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Lamini, Pipedream and 2,700+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular