diff --git a/docs/api/mlmd.errors/index.md b/docs/api/mlmd.errors/index.md new file mode 100644 index 000000000..04562c7fa --- /dev/null +++ b/docs/api/mlmd.errors/index.md @@ -0,0 +1,45 @@ +# mlmd.errors + +Exception types for MLMD errors. + +## Classes + +[`class AbortedError`][ml_metadata.errors.AbortedError]: The operation was aborted, typically due to a concurrent action. + +[`class AlreadyExistsError`][ml_metadata.errors.AlreadyExistsError]: Raised when an entity that we attempted to create already exists. + +[`class CancelledError`][ml_metadata.errors.CancelledError]: Raised when an operation or step is cancelled. + +[`class DataLossError`][ml_metadata.errors.DataLossError]: Raised when unrecoverable data loss or corruption is encountered. + +[`class DeadlineExceededError`][ml_metadata.errors.DeadlineExceededError]: Raised when a deadline expires before an operation could complete. + +[`class FailedPreconditionError`][ml_metadata.errors.FailedPreconditionError]: Raised when the system is not in a state to execute an operation. + +[`class InternalError`][ml_metadata.errors.InternalError]: Raised when the system experiences an internal error. + +[`class InvalidArgumentError`][ml_metadata.errors.InvalidArgumentError]: Raised when an operation receives an invalid argument. + +[`class NotFoundError`][ml_metadata.errors.NotFoundError]: Raised when a requested entity was not found. + +[`class OutOfRangeError`][ml_metadata.errors.OutOfRangeError]: Raised when an operation iterates past the valid input range. + +[`class PermissionDeniedError`][ml_metadata.errors.PermissionDeniedError]: Raised when the caller does not have permission to run an operation. + +[`class ResourceExhaustedError`][ml_metadata.errors.ResourceExhaustedError]: Some resource has been exhausted. + +[`class StatusError`][ml_metadata.errors.StatusError]: A general error class that cast maps Status to typed errors. + +[`class UnauthenticatedError`][ml_metadata.errors.UnauthenticatedError]: The request does not have valid authentication credentials. + +[`class UnavailableError`][ml_metadata.errors.UnavailableError]: Raised when the runtime is currently unavailable. + +[`class UnimplementedError`][ml_metadata.errors.UnimplementedError]: Raised when an operation has not been implemented. + +[`class UnknownError`][ml_metadata.errors.UnknownError]: Raised when an operation failed reason is unknown. + +## Functions + +[`exception_type_from_error_code(...)`][ml_metadata.errors.exception_type_from_error_code]: Returns error class w.r.t. the error_code. + +[`make_exception(...)`][ml_metadata.errors.make_exception]: Makes an exception with the MLMD error code. diff --git a/docs/api/mlmd.errors/mlmd.errors.md b/docs/api/mlmd.errors/mlmd.errors.md new file mode 100644 index 000000000..3c1dada6c --- /dev/null +++ b/docs/api/mlmd.errors/mlmd.errors.md @@ -0,0 +1,5 @@ +# mlmd.errors + +::: ml_metadata.errors + options: + show_if_no_docstring: true diff --git a/docs/api/mlmd.proto/index.md b/docs/api/mlmd.proto/index.md new file mode 100644 index 000000000..a7cf83f20 --- /dev/null +++ b/docs/api/mlmd.proto/index.md @@ -0,0 +1,35 @@ +# mlmd.proto + +ML Metadata proto module. + +## Classes + +[`class Artifact`][ml_metadata.proto.Artifact]: An artifact represents an input or an output of individual steps in a ML workflow, e.g., a trained model, an input dataset, and evaluation metrics. + +[`class ArtifactType`][ml_metadata.proto.ArtifactType]: A user defined type about a collection of artifacts and their properties that are stored in the metadata store. + +[`class Association`][ml_metadata.proto.Association]: An association represents the relationship between executions and contexts. + +[`class Attribution`][ml_metadata.proto.Attribution]: An attribution represents the relationship between artifacts and contexts. + +[`class ConnectionConfig`][ml_metadata.proto.ConnectionConfig]: A connection configuration specifying the persistent backend to be used with MLMD. + +[`class Context`][ml_metadata.proto.Context]: A context defines a group of artifacts and/or executions. + +[`class ContextType`][ml_metadata.proto.ContextType]: A user defined type about a collection of contexts and their properties that are stored in the metadata store. + +[`class Event`][ml_metadata.proto.Event]: An event records the relationship between artifacts and executions. + +[`class Execution`][ml_metadata.proto.Execution]: An execution describes a component run or a step in an ML workflow along with its runtime parameters, e.g., a Trainer run, a data transformation step. + +[`class ExecutionType`][ml_metadata.proto.ExecutionType]: A user defined type about a collection of executions and their properties that are stored in the metadata store. + +[`class FakeDatabaseConfig`][ml_metadata.proto.FakeDatabaseConfig]: An in-memory database configuration for testing purpose. + +[`class MetadataStoreClientConfig`][ml_metadata.proto.MetadataStoreClientConfig]: A connection configuration to use a MLMD server as the persistent backend. + +[`class MySQLDatabaseConfig`][ml_metadata.proto.MySQLDatabaseConfig]: A connection configuration to use a MySQL db instance as a MLMD backend. + +[`class ParentContext`][ml_metadata.proto.ParentContext]: A parental context represents the relationship between contexts. + +[`class SqliteMetadataSourceConfig`][ml_metadata.proto.SqliteMetadataSourceConfig]: A connection configuration to use a Sqlite db file as a MLMD backend. diff --git a/docs/api/mlmd.proto/mlmd.proto.md b/docs/api/mlmd.proto/mlmd.proto.md new file mode 100644 index 000000000..e190a876c --- /dev/null +++ b/docs/api/mlmd.proto/mlmd.proto.md @@ -0,0 +1,5 @@ +# mlmd.proto + +::: ml_metadata.proto + options: + show_if_no_docstring: true diff --git a/docs/api/mlmd/index.md b/docs/api/mlmd/index.md new file mode 100644 index 000000000..4a1890b72 --- /dev/null +++ b/docs/api/mlmd/index.md @@ -0,0 +1,23 @@ +# mlmd + +Init module for ML Metadata. + +## Modules + +[`errors`][ml_metadata.errors] module: Exception types for MLMD errors. + +[`proto`][ml_metadata.proto] module: ML Metadata proto module. + +## Classes + +[`class ListOptions`][ml_metadata.ListOptions]: Defines the available options when listing nodes. + +[`class MetadataStore`][ml_metadata.MetadataStore]: A store for the metadata. + +[`class OrderByField`][ml_metadata.OrderByField]: Defines the available fields to order results in ListOperations. + +## Functions + +[`downgrade_schema(...)`][ml_metadata.downgrade_schema]: Downgrades the db specified in the connection config to a schema version. + + diff --git a/docs/api/mlmd/mlmd.md b/docs/api/mlmd/mlmd.md new file mode 100644 index 000000000..7ac8b930f --- /dev/null +++ b/docs/api/mlmd/mlmd.md @@ -0,0 +1,5 @@ +# mlmd + +::: ml_metadata + options: + show_submodules: false diff --git a/docs/images/favicon.png b/docs/images/favicon.png new file mode 100644 index 000000000..00a8af6da Binary files /dev/null and b/docs/images/favicon.png differ diff --git a/docs/images/mlmd_flow.png b/docs/images/mlmd_flow.png new file mode 100644 index 000000000..72b39b927 Binary files /dev/null and b/docs/images/mlmd_flow.png differ diff --git a/docs/images/mlmd_overview.png b/docs/images/mlmd_overview.png new file mode 100644 index 000000000..a5e5e05ed Binary files /dev/null and b/docs/images/mlmd_overview.png differ diff --git a/docs/images/tf_full_color_primary_icon.svg b/docs/images/tf_full_color_primary_icon.svg new file mode 100644 index 000000000..3e7247778 --- /dev/null +++ b/docs/images/tf_full_color_primary_icon.svg @@ -0,0 +1 @@ +FullColorPrimary Icon \ No newline at end of file diff --git a/docs/javascripts/mathjax.js b/docs/javascripts/mathjax.js new file mode 100644 index 000000000..0be88e041 --- /dev/null +++ b/docs/javascripts/mathjax.js @@ -0,0 +1,19 @@ +window.MathJax = { + tex: { + inlineMath: [["\\(", "\\)"]], + displayMath: [["\\[", "\\]"]], + processEscapes: true, + processEnvironments: true + }, + options: { + ignoreHtmlClass: ".*|", + processHtmlClass: "arithmatex" + } +}; + +document$.subscribe(() => { + MathJax.startup.output.clearCache() + MathJax.typesetClear() + MathJax.texReset() + MathJax.typesetPromise() +}) diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 000000000..beaf9694e --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,19 @@ +:root { + --md-primary-fg-color: #FFA800; + --md-primary-fg-color--light: #CCCCCC; + --md-primary-fg-color--dark: #425066; +} + +.video-wrapper { + max-width: 240px; + display: flex; + flex-direction: row; +} +.video-wrapper > iframe { + width: 100%; + aspect-ratio: 16 / 9; +} + +p img{ + background: white; +}