add lib, add process.env.MLFLOW_TRACKING_URI to example, clean up gitignore

Author: yiqunzheng

mlflow/.gitignore

@@ -1,6 +1,12 @@
 # Dependencies
 node_modules/
 
+# Environment variables
+.env
+
+# IDE
+.vscode
+
 # Misc
 .DS_Store
 ../.DS_Store
@@ -9,8 +15,12 @@ node_modules/
 .venv/
 mlruns/
 
-# Build output
-lib/
-
 # Temporary files
-temp/
+temp/
+
+# Test coverage 
+coverage/
+
+
+
+=

mlflow/examples/LinearRegressionExample.js

@@ -14,15 +14,23 @@
  * @requires @tensorflow/tfjs-node
  * @requires @mlflow.js
  *
- * @note Ensure MLflow server is running at http://localhost:5001 before executing
+ * @note Ensure MLflow server is running before executing
  */
 
 import * as tf from '@tensorflow/tfjs-node';
-import MLflow from 'mlflow-js';
+import Mlflow from 'mlflow-js';
 import { fileURLToPath } from 'url';
-import { dirname } from 'path';
+import { dirname, join } from 'path';
+import dotenv from 'dotenv';
 
-const mlflow = new MLflow('http://localhost:5001');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+dotenv.config({ path: join(__dirname, '../.env') });
+
+const MLFLOW_TRACKING_URI =
+  process.env.MLFLOW_TRACKING_URI || 'http://localhost:5001';
+const mlflow = new Mlflow(MLFLOW_TRACKING_URI);
+console.log('MLflow server URL:', MLFLOW_TRACKING_URI);
 
 const HYPERPARAMETERS = {
   learningRate: 0.25,

mlflow/lib/index.d.ts

@@ -0,0 +1,2 @@
+import Mlflow from './mlflow.js';
+export default Mlflow;

mlflow/lib/index.js

@@ -0,0 +1,20 @@
+import ExperimentClient from './tracking/ExperimentClient.js';
+import ExperimentManager from './workflows/ExperimentManager.js';
+import RunClient from './tracking/RunClient.js';
+import RunManager from './workflows/RunManager.js';
+import ModelRegistryClient from './model-registry/ModelRegistryClient.js';
+import ModelVersionClient from './model-registry/ModelVersionClient.js';
+import ModelManager from './workflows/ModelManager.js';
+declare class Mlflow {
+    private components;
+    constructor(trackingUri: string);
+    private initializeMethods;
+    getExperimentClient(): ExperimentClient;
+    getRunClient(): RunClient;
+    getModelRegistryClient(): ModelRegistryClient;
+    getModelVersionClient(): ModelVersionClient;
+    getExperimentManager(): ExperimentManager;
+    getRunManager(): RunManager;
+    getModelManager(): ModelManager;
+}
+export default Mlflow;

mlflow/lib/index.js.map

@@ -0,0 +1,119 @@
+declare class ModelRegistryClient {
+    private baseUrl;
+    constructor(trackingUri: string);
+    /**
+     * Creates a new registered model.
+     *
+     * @param {string} name - The name of the model to register (required)
+     * @param {Array<{key: string, value: string}>} [tags] - Optional tags for the model
+     * @param {string} [description] - Optional description for the model
+     * @returns {Promise<RegisteredModel>} The created registered model object
+     * @throws {ApiError} If the API request fails
+     */
+    createRegisteredModel(name: string, tags?: Array<{
+        key: string;
+        value: string;
+    }>, description?: string): Promise<object>;
+    /**
+     * Retrieves a registered model by name.
+     *
+     * @param {string} name - The name of the registered model to retrieve (required)
+     * @returns {Promise<RegisteredModel>} The registered model object
+     * @throws {ApiError} If the API request fails
+     */
+    getRegisteredModel(name: string): Promise<object>;
+    /**
+     * Renames a registered model.
+     *
+     * @param {string} name - The current name of the registered model (required)
+     * @param {string} newName - The new name for the registered model (required)
+     * @returns {Promise<RegisteredModel>} The updated registered model object
+     * @throws {ApiError} If the API request fails
+     */
+    renameRegisteredModel(name: string, newName: string): Promise<object>;
+    /**
+     * Updates a registered model's description.
+     *
+     * @param {string} name - The name of the registered model to update (required)
+     * @param {string} [description] - The new description for the model
+     * @returns {Promise<RegisteredModel>} The updated registered model object
+     * @throws {ApiError} If the API request fails
+     */
+    updateRegisteredModel(name: string, description?: string): Promise<object>;
+    /**
+     * Deletes a registered model.
+     *
+     * @param {string} name - The name of the registered model to delete (required)
+     * @returns {Promise<void>}
+     * @throws {ApiError} If the API request fails
+     */
+    deleteRegisteredModel(name: string): Promise<void>;
+    /**
+     * Gets the latest versions of a registered model.
+     *
+     * @param {string} name - The name of the registered model (required)
+     * @param {string[]} [stages] - Optional array of stages to filter the versions by
+     * @returns {Promise<ModelVersion[]>} An array of the latest model versions
+     * @throws {ApiError} If the API request fails
+     */
+    getLatestModelVersions(name: string, stages?: string[]): Promise<Array<object>>;
+    /**
+     * Searches for registered models based on filter criteria.
+     *
+     * @param {string} [filter] - Optional filter string to apply to the search
+     * @param {number} [maxResults] - Optional maximum number of results to return
+     * @param {string[]} [orderBy] - Optional array of fields to order the results by
+     * @param {string} [pageToken] - Optional token for pagination
+     * @returns {Promise<{registered_models: RegisteredModel[], next_page_token: string}>} An object containing the search results and pagination information
+     * @throws {ApiError} If the API request fails
+     */
+    searchRegisteredModels(filter?: string, maxResults?: number, orderBy?: string[], pageToken?: string): Promise<object>;
+    /**
+     * Sets a tag on a registered model.
+     *
+     * @param {string} name - The name of the registered model (required)
+     * @param {string} key - The key of the tag (required)
+     * @param {string} value - The value of the tag (required)
+     * @returns {Promise<void>}
+     * @throws {ApiError} If the API request fails
+     */
+    setRegisteredModelTag(name: string, key: string, value: string): Promise<void>;
+    /**
+     * Deletes a tag from a registered model.
+     *
+     * @param {string} name - The name of the registered model (required)
+     * @param {string} key - The key of the tag to delete (required)
+     * @returns {Promise<void>}
+     * @throws {ApiError} If the API request fails
+     */
+    deleteRegisteredModelTag(name: string, key: string): Promise<void>;
+    /**
+     * Sets an alias for a specific version of a registered model.
+     *
+     * @param {string} name - The name of the registered model (required)
+     * @param {string} alias - The alias to set (required)
+     * @param {string} version - The version number to associate with the alias (required)
+     * @returns {Promise<void>}
+     * @throws {ApiError} If the API request fails
+     */
+    setRegisteredModelAlias(name: string, alias: string, version: string): Promise<void>;
+    /**
+     * Deletes an alias from a registered model.
+     *
+     * @param {string} name - The name of the registered model (required)
+     * @param {string} alias - The alias to delete (required)
+     * @returns {Promise<void>}
+     * @throws {ApiError} If the API request fails
+     */
+    deleteRegisteredModelAlias(name: string, alias: string): Promise<void>;
+    /**
+     * Retrieves a model version using its alias.
+     *
+     * @param {string} name - The name of the registered model (required)
+     * @param {string} alias - The alias of the model version to retrieve (required)
+     * @returns {Promise<ModelVersion>} The model version object
+     * @throws {ApiError} If the API request fails
+     */
+    getModelVersionByAlias(name: string, alias: string): Promise<object>;
+}
+export default ModelRegistryClient;