diff --git a/md-docs/user_guide/company.md b/md-docs/user_guide/company.md new file mode 100644 index 0000000..bf9470e --- /dev/null +++ b/md-docs/user_guide/company.md @@ -0,0 +1,59 @@ +# Company and Subscriptions + +A Company is the fundamental organizational entity inside ML cube Platform. +Users belong to a single Company and billing, licenses, and projects are all managed and created inside a Company. + +The Company has an Owner with maximum privileges including billing administration. +The owner can create new User accounts inside the Company assigning specific [roles] at the company and project level. + +The information required that describe the Company are: + +- Company name +- Address +- VAT + +The Company is created by ML cube team during the onboarding, then, during first login the Owner needs to complete the remaining information. + +## Subscriptions + +A Subscription is the payment arrangement where a Company pays a periodical fee to access ML cube Platform services. +A Subscription has a *start* and an *expiration* date and contains the *modules* and *quotas* the Company can handle. + +=== "Quotas" + + | Quota | Description | + | ----------- | ------------------------------------ | + | Users | Maximum number of Users per Company| + | Tasks | Maximum number of Tasks per Company excluding those in demo projects| + +=== "Modules" + + | Modules | Description | + | ----------- | ------------------------------------ | + | Monitoring | Data drift monitoring and detection for several targets and metrics. Alerts are raised when drifts are detected allowing automated the response. | + | Retraining | Generation of retraining datasets to update AI models according to identified data drifts. Dataset is based on data distributions and leverages all the past available data. | + | Explainability | Explainability of detected drifts to better understand what happened and how to tackle it. | + + +Moreover, there are two types of subcriptions depending on where ML cube Platform is used: + +
+- :material-cloud:{ .lg .middle .green-icon} **Cloud** + + --- + + Standard SaaS plan to use ML cube Platform hosted on ML cube cloud infrastructure. + With Cloud subscription the users can use Web Application and SDK to interact with ML cube Platform and to use its services. + Data can be stored on ML cube Private Cloud Storage. + +- :fontawesome-solid-computer:{ .lg .middle .green-icon} **Edge** + + --- + + Edge subscriptions are used, as the name suggests, for edge devices that hosts ML cube Platform Edge. + A common use case is an industrial machinery computer that runs AI algorithms. + Edge subscriptions are validated via Product Key and are uniquely linked to a specific edge device. + +
+ +[roles]: rbac.md \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index d649eba..1e59333 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -106,6 +106,7 @@ nav: - index.md - User Guide: - user_guide/index.md + - user_guide/company.md - Modules: - user_guide/modules/index.md