diff --git a/docs/hub/_toctree.yml b/docs/hub/_toctree.yml index d5b2f0405..0e0bc99bf 100644 --- a/docs/hub/_toctree.yml +++ b/docs/hub/_toctree.yml @@ -279,6 +279,10 @@ title: Tabby on Spaces - local: spaces-sdks-docker-giskard title: Giskard on Spaces + - local: spaces-sdks-docker-evidence + title: Evidence on Spaces + - local: spaces-sdks-docker-marimo + title: marimo on Spaces - local: spaces-embed title: Embed your Space - local: spaces-run-with-docker @@ -321,27 +325,27 @@ title: Organization Cards - local: organizations-security title: Access Control in Organizations - - local: enterprise-hub - title: Enterprise Hub - sections: - - local: enterprise-sso - title: Single Sign-On (SSO) - - local: audit-logs - title: Audit Logs - - local: storage-regions - title: Storage Regions - - local: enterprise-hub-datasets - title: Dataset viewer for Private datasets - - local: enterprise-hub-resource-groups - title: Resource Groups (Access Control) - - local: advanced-compute-options - title: Advanced Compute Options - - local: enterprise-hub-advanced-security - title: Advanced Security - - local: enterprise-hub-tokens-management - title: Tokens Management - - local: enterprise-hub-analytics - title: Analytics + - local: enterprise-hub + title: Enterprise Hub + sections: + - local: enterprise-sso + title: Single Sign-On (SSO) + - local: audit-logs + title: Audit Logs + - local: storage-regions + title: Storage Regions + - local: enterprise-hub-datasets + title: Dataset viewer for Private datasets + - local: enterprise-hub-resource-groups + title: Resource Groups (Access Control) + - local: advanced-compute-options + title: Advanced Compute Options + - local: enterprise-hub-advanced-security + title: Advanced Security + - local: enterprise-hub-tokens-management + title: Tokens Management + - local: enterprise-hub-analytics + title: Analytics - local: billing title: Billing - local: security diff --git a/docs/hub/advanced-compute-options.md b/docs/hub/advanced-compute-options.md index 4f42d9b04..ff74e2941 100644 --- a/docs/hub/advanced-compute-options.md +++ b/docs/hub/advanced-compute-options.md @@ -1,15 +1,28 @@ # Advanced Compute Options -Enterprise Hub organizations gain access to advanced compute options to accelerate their machine learning journey. - -This feature is part of the Enterprise Hub. +This feature is part of the Enterprise Hub. +Enterprise Hub organizations gain access to advanced compute options to accelerate their machine learning journey. + ## Host ZeroGPU Spaces in your organization ZeroGPU is a dynamic GPU allocation system that optimizes AI deployment on Hugging Face Spaces. By automatically allocating and releasing NVIDIA A100 GPUs (40GB VRAM) as needed, organizations can efficiently serve their AI applications without dedicated GPU instances. +
+ screenshot of Hugging Face Advanced Compute Options (ZeroGPU) + +
+ **Key benefits for organizations** - **Free GPU Access**: Access powerful NVIDIA A100 GPUs at no additional cost through dynamic allocation diff --git a/docs/hub/audit-logs.md b/docs/hub/audit-logs.md index 0babbf71c..a5d58754c 100644 --- a/docs/hub/audit-logs.md +++ b/docs/hub/audit-logs.md @@ -1,12 +1,23 @@ # Audit Logs -This feature is part of the Enterprise Hub. +This feature is part of the Enterprise Hub. Audit Logs enable organization admins to easily review actions taken by members, including organization membership, repository settings and billing changes. -![](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/enterprise/audit-logs.png) +
+ screenshot of Hugging Face Audit Logs feature + +
## Accessing Audit Logs diff --git a/docs/hub/enterprise-hub-advanced-security.md b/docs/hub/enterprise-hub-advanced-security.md index 8dcdc3b87..9213f3737 100644 --- a/docs/hub/enterprise-hub-advanced-security.md +++ b/docs/hub/enterprise-hub-advanced-security.md @@ -1,12 +1,12 @@ # Advanced Security -This feature is part of the Enterprise Hub. +This feature is part of the Enterprise Hub. Enterprise Hub organizations can improve their security with advanced security controls for both members and repositories. -
+
screenshot of the Dataset Viewer on a private dataset owned by an Enterprise Hub organization.
diff --git a/docs/hub/enterprise-hub-analytics.md b/docs/hub/enterprise-hub-analytics.md index ef8cb1465..24ba517d8 100644 --- a/docs/hub/enterprise-hub-analytics.md +++ b/docs/hub/enterprise-hub-analytics.md @@ -1,14 +1,14 @@ # Analytics -This feature is part of the Enterprise Hub. +This feature is part of the Enterprise Hub. ## Analytics Dashboard Track all your repository activity with a detailed downloads overview that shows total downloads for all your Models and Datasets. Toggle between "All Time" and "Last Month" views to gain insights into your repository's downloads over different periods. -
+
screenshot of the Dataset Viewer on a private dataset owned by an Enterprise Hub organization.
diff --git a/docs/hub/enterprise-hub-datasets.md b/docs/hub/enterprise-hub-datasets.md index 4863e7391..5a224a8de 100644 --- a/docs/hub/enterprise-hub-datasets.md +++ b/docs/hub/enterprise-hub-datasets.md @@ -1,14 +1,14 @@ # Datasets -This feature is part of the Enterprise Hub. +This feature is part of the Enterprise Hub. -The Dataset Viewer is enabled on private datasets owned by an Enterprise Hub organization. +The Dataset Viewer is enabled on private datasets owned by an Enterprise Hub organization. The Dataset Viewer allows teams to understand their data and to help them build better data processing and filtering for AI. The Viewer allows to explore the datasets content, inspect data distributions, filter by values and even search for keywords. It also includes the datasets conversion to Parquet which can be used for programmatic data visualization. -See [Dataset Viewer](./datasets-viewer) for more information. +[More information about the Dataset Viewer →](./datasets-viewer)
screenshot of the Dataset Viewer on a private dataset owned by an Enterprise Hub organization. diff --git a/docs/hub/enterprise-hub-resource-groups.md b/docs/hub/enterprise-hub-resource-groups.md index e2dd79f3b..036c93e5d 100644 --- a/docs/hub/enterprise-hub-resource-groups.md +++ b/docs/hub/enterprise-hub-resource-groups.md @@ -1,9 +1,32 @@ # Resource groups -This feature is part of the Enterprise Hub. +This feature is part of the Enterprise Hub. -Resource Groups allow Enterprise Hub organizations to enforce fine-grained access control to their repositories. +Resource Groups allow organizations to enforce fine-grained access control to their repositories. -Read the [documentation for Resource Groups under the Security section](./security-resource-groups). +
+ screenshot of Hugging Face Single Sign-On (SSO) feature + +
+ +This feature allows organization administrators to: + +- Group related repositories together for better organization +- Control member access at a group level rather than individual repository level +- Assign different permission roles (read, contributor, write, admin) to team members +- Keep private repositories visible only to authorized group members +- Enable multiple teams to work independently within the same organization + +This Enterprise Hub feature helps organizations manage complex team structures and maintain proper access control over their repositories. + +[Getting started with Resource Groups →](./security-resource-groups) diff --git a/docs/hub/enterprise-hub-tokens-management.md b/docs/hub/enterprise-hub-tokens-management.md index f3fc9b111..9717fd909 100644 --- a/docs/hub/enterprise-hub-tokens-management.md +++ b/docs/hub/enterprise-hub-tokens-management.md @@ -1,59 +1,54 @@ # Tokens Management -This feature is part of the Enterprise Hub. +This feature is part of the Enterprise Hub. -Tokens Management allows organization administrators to control access tokens within their organization, ensuring that only authorized users have access to organization resources. - +Tokens Management enables organization administrators to oversee access tokens within their organization, ensuring secure access to organization resources. ## Viewing and Managing Access Tokens -The token listing feature provides a view of all access tokens within your organization. Administrators can: +The token listing feature displays all access tokens within your organization. Administrators can: - Monitor token usage and identify or prevent potential security risks: - - unauthorized access to private resources ("leak") - - scopes of access that are too wide - - improvable token hygienics (tokens that have not been rotated in a long time, for example) -- Identify inactive or unused tokens that can be revoked + - Unauthorized access to private resources ("leaks") + - Overly broad access scopes + - Suboptimal token hygiene (e.g., tokens that have not been rotated in a long time) +- Identify and revoke inactive or unused tokens
- -Fine-grained tokens can be reviewed to see their permissions: +Fine-grained tokens display their specific permissions:
+## Token Policy -## Token policy - -With Tokens Management, Enterprise org admins can decide which of the following policies they want to enforce: - -| **Policy** | **Unscoped (Read/Write) Access Tokens** | **Fine-Grained Tokens** | -| --- | --- | --- | -| **Allow access via User Access Tokens (default)** | Authorized | Authorized | -| **Only access via fine-grained tokens** | Unauthorized | Authorized | -| **Do not require administrator approval** | Unauthorized | Authorized | -| **Require administrator approval** | Unauthorized | Unauthorized without an approval (except for admin-created) | +Enterprise organization administrators can enforce the following policies: +| **Policy** | **Unscoped (Read/Write) Access Tokens** | **Fine-Grained Tokens** | +| ------------------------------------------------- | --------------------------------------- | ----------------------------------------------------------- | +| **Allow access via User Access Tokens (default)** | Authorized | Authorized | +| **Only access via fine-grained tokens** | Unauthorized | Authorized | +| **Do not require administrator approval** | Unauthorized | Authorized | +| **Require administrator approval** | Unauthorized | Unauthorized without an approval (except for admin-created) |
- ## Reviewing Token Authorization -When your token policy is set to "Require administrator approval", organization administrators can view the details of all fine-grained tokens with access to resources owned by the organization. They can also revoke access to those tokens. Organization administrators will receive an email when an authorization is requested for a fine-grained token. +When token policy is set to "Require administrator approval", organization administrators can review details of all fine-grained tokens accessing organization-owned resources and revoke access if needed. Administrators receive email notifications for token authorization requests. -When a token is revoked or denied, the user who created the token will receive an email notification. +When a token is revoked or denied, the user who created the token receives an email notification.
diff --git a/docs/hub/enterprise-hub.md b/docs/hub/enterprise-hub.md index 10cc43e3e..f171b3611 100644 --- a/docs/hub/enterprise-hub.md +++ b/docs/hub/enterprise-hub.md @@ -1,12 +1,19 @@ # Enterprise Hub + +Subscribe to Enterprise Hub to get access to advanced features for your organization. + + Enterprise Hub adds advanced capabilities to organizations, enabling safe, compliant and managed collaboration for companies and teams on Hugging Face. -![](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/enterprise/enterprise-hub.png) + + + + In this section we will document the following Enterprise Hub features: -- [SSO](./enterprise-sso) +- [Single Sign-On (SSO)](./enterprise-sso) - [Audit Logs](./audit-logs) - [Storage Regions](./storage-regions) - [Dataset viewer for Private datasets](./enterprise-hub-datasets) diff --git a/docs/hub/enterprise-sso.md b/docs/hub/enterprise-sso.md index a115e365e..bbe34fd44 100644 --- a/docs/hub/enterprise-sso.md +++ b/docs/hub/enterprise-sso.md @@ -1,7 +1,32 @@ # Single Sign-On (SSO) -This feature is part of the Enterprise Hub. +This feature is part of the Enterprise Hub. -Read the [documentation for SSO under the Security section](./security-sso). +Single sign-on (SSO) allows organizations to securely manage user authentication through their own identity provider (IdP). Both SAML 2.0 and OpenID Connect (OIDC) protocols are supported. + +
+ screenshot of Hugging Face Single Sign-On (SSO) feature + +
+ +This feature allows organizations to: + +- Enforce mandatory authentication through your company's IdP +- Automatically manage user access and roles based on your IdP attributes +- Support popular providers like Okta, OneLogin, and Azure Active Directory +- Maintain security while allowing external collaborators when needed +- Control session timeouts and role mappings + +This Enterprise Hub feature helps organizations maintain consistent security policies while giving their teams seamless access to Hugging Face resources. + +[Getting started with SSO →](./security-sso) diff --git a/docs/hub/organizations-security.md b/docs/hub/organizations-security.md index 8ce6b8c3e..886a4321f 100644 --- a/docs/hub/organizations-security.md +++ b/docs/hub/organizations-security.md @@ -10,7 +10,7 @@ You can set up [Single Sign-On (SSO)](./security-sso) to be able to map access c Advanced and more fine-grained access control can be achieved with [Resource Groups](./security-resource-groups). -The Resource Group feature is part of the Enterprise Hub. +The Resource Group feature is part of the Enterprise Hub. @@ -31,25 +31,22 @@ As an organization `admin`, go to the **Members** section of the org settings to
- ## Viewing members' email address -This feature is part of the Enterprise Hub. +This feature is part of the Enterprise Hub. You may be able to view the email addresses of members of your organization. The visibility of the email addresses depends on the organization's SSO configuration, or verified organization status. - If you [verify a domain for your organization](./organizations-managing#organization-domain-name), you can view members' email addresses for the verified domain. -- If SSO is configured for your organization, you can view the email address for each of your organization members by setting `Matching email domains` in the SSO configuration - +- If SSO is configured for your organization, you can view the email address for each of your organization members by setting `Matching email domains` in the SSO configuration
- ## Managing Access Tokens with access to my organization -See [Tokens Management](./enterprise-hub-tokens-management) \ No newline at end of file +See [Tokens Management](./enterprise-hub-tokens-management) diff --git a/docs/hub/security-resource-groups.md b/docs/hub/security-resource-groups.md index b90bae536..3e0677909 100644 --- a/docs/hub/security-resource-groups.md +++ b/docs/hub/security-resource-groups.md @@ -1,7 +1,7 @@ # Advanced Access Control in Organizations with Resource Groups -This feature is part of the Enterprise Hub. +This feature is part of the Enterprise Hub. In your Hugging Face organization, you can use Resource Groups to control which members have access to specific repositories. @@ -55,4 +55,3 @@ Remember that a repository can be part of only one Resource Group. You'll be war ## Programmatic management (API) Coming soon! - diff --git a/docs/hub/security-sso-azure-oidc.md b/docs/hub/security-sso-azure-oidc.md index 9c4c447df..acbdeafb0 100644 --- a/docs/hub/security-sso-azure-oidc.md +++ b/docs/hub/security-sso-azure-oidc.md @@ -1,13 +1,11 @@ # How to configure OIDC SSO with Azure -This guide will use Azure as the SSO provider and the Open ID Connect (OIDC) protocol as our preferred identity protocol. - +This guide will use Azure as the SSO provider and the Open ID Connect (OIDC) protocol as our preferred identity protocol. - This feature is part of the Enterprise Hub. + This feature is part of the Enterprise Hub. - ### Step 1: Create a new application in your Identity Provider Open a new tab/window in your browser and sign in to the Azure portal of your organization. @@ -44,7 +42,6 @@ Open a new tab/window in your browser and navigate to the SSO section of your or
- Copy the "Redirection URI" from the organization's settings on Hugging Face and paste it into the "Redirect URI" field on Azure Entra ID. Make sure you select "Web" in the dropdown menu. The URL looks like this: `https://huggingface.co/organizations/[organizationIdentifier]/oidc/consume`. @@ -57,6 +54,7 @@ Save your new application. ### Step 3: Finalize configuration on Hugging Face We will need to collect the following information to finalize the setup on Hugging Face: + - The Client ID of the OIDC app - A Client secret of the OIDC app - The Issuer URL of the OIDC app @@ -99,14 +97,12 @@ Once you have created the secret, copy the secret value and paste it into the "C
- You can now click "Update and Test OIDC configuration" to save the settings. You should be redirected to your SSO provider (IdP) login prompt. Once logged in, you'll be redirected to your organization's settings page. A green check mark near the OIDC selector will attest that the test was successful. -
diff --git a/docs/hub/security-sso-azure-saml.md b/docs/hub/security-sso-azure-saml.md index 1237171b7..578afce84 100644 --- a/docs/hub/security-sso-azure-saml.md +++ b/docs/hub/security-sso-azure-saml.md @@ -1,11 +1,11 @@ # How to configure SAML SSO with Azure -In this guide, we will use Azure as the SSO provider and with the Security Assertion Markup Language (SAML) protocol as our preferred identity protocol. +In this guide, we will use Azure as the SSO provider and with the Security Assertion Markup Language (SAML) protocol as our preferred identity protocol. We currently support SP-initiated and IdP-initiated authentication. User provisioning is not yet supported at this time. - This feature is part of the Enterprise Hub. + This feature is part of the Enterprise Hub. ### Step 1: Create a new application in your Identity Provider @@ -30,7 +30,6 @@ Then select "Single Sign-On", and select SAML
- ### Step 2: Configure your application on Azure Open a new tab/window in your browser and navigate to the SSO section of your organization's settings. Select the SAML protocol. @@ -49,7 +48,6 @@ Copy the "SP Entity Id" from the organization's settings on Hugging Face, and pa Copy the "Assertion Consumer Service URL" from the organization's settings on Hugging Face, and paste it in the "Reply URL" field on Azure (2). - The URL looks like this: `https://huggingface.co/organizations/[organizationIdentifier]/saml/consume`.
@@ -62,20 +60,20 @@ Then under "SAML Certificates", verify that "Signin Option" is set to "Sign SAML
- Save your new application. ### Step 3: Finalize configuration on Hugging Face In your Azure application, under "Set up", find the following field: + - Login Url And under "SAML Certificates": + - Download the "Certificate (base64)" You will need them to finalize the SSO setup on Hugging Face. -
@@ -104,7 +102,6 @@ You should be redirected to your SSO provider (IdP) login prompt. Once logged in A green check mark near the SAML selector will attest that the test was successful. -
diff --git a/docs/hub/security-sso-okta-oidc.md b/docs/hub/security-sso-okta-oidc.md index adcb0821b..92d65bcf0 100644 --- a/docs/hub/security-sso-okta-oidc.md +++ b/docs/hub/security-sso-okta-oidc.md @@ -1,9 +1,9 @@ # How to configure OIDC SSO with Okta -In this guide, we will use Okta as the SSO provider and with the Open ID Connect (OIDC) protocol as our preferred identity protocol. +In this guide, we will use Okta as the SSO provider and with the Open ID Connect (OIDC) protocol as our preferred identity protocol. - This feature is part of the Enterprise Hub. + This feature is part of the Enterprise Hub. ### Step 1: Create a new application in your Identity Provider @@ -26,7 +26,6 @@ Then choose an “OIDC - OpenID Connect” application, select the application t Open a new tab/window in your browser and navigate to the SSO section of your organization's settings. Select the OIDC protocol. -
@@ -46,26 +45,23 @@ You can leave the optional Sign-out redirect URIs blank.
- Save your new application. ### Step 3: Finalize configuration on Hugging Face In your Okta application, under "General", find the following fields: + - Client ID - Client secret - Issuer URL -You will need these to finalize the SSO setup on Hugging Face. - + You will need these to finalize the SSO setup on Hugging Face. The Okta Issuer URL is generally a URL like `https://tenantId.okta.com`; you can refer to their [guide](https://support.okta.com/help/s/article/What-is-theIssuerlocated-under-the-OpenID-Connect-ID-Token-app-settings-used-for?language=en_US) for more details. -
- In the SSO section of your organization's settings on Hugging Face, copy-paste these values from Okta: - Client ID @@ -82,7 +78,6 @@ You should be redirected to your SSO provider (IdP) login prompt. Once logged in A green check mark near the OIDC selector will attest that the test was successful. -
diff --git a/docs/hub/security-sso-okta-saml.md b/docs/hub/security-sso-okta-saml.md index 2cab374de..d6e194d10 100644 --- a/docs/hub/security-sso-okta-saml.md +++ b/docs/hub/security-sso-okta-saml.md @@ -1,11 +1,11 @@ # How to configure SAML SSO with Okta -In this guide, we will use Okta as the SSO provider and with the Security Assertion Markup Language (SAML) protocol as our preferred identity protocol. +In this guide, we will use Okta as the SSO provider and with the Security Assertion Markup Language (SAML) protocol as our preferred identity protocol. We currently support SP-initiated and IdP-initiated authentication. User provisioning is not yet supported at this time. - This feature is part of the Enterprise Hub. + This feature is part of the Enterprise Hub. ### Step 1: Create a new application in your Identity Provider @@ -20,12 +20,10 @@ Navigate to "Admin/Applications" and click the "Create App Integration" button. Then choose an "SAML 2.0" application and click "Create". -
- ### Step 2: Configure your application on Okta Open a new tab/window in your browser and navigate to the SSO section of your organization's settings. Select the SAML protocol. @@ -49,21 +47,20 @@ The URL looks like this: `https://huggingface.co/organizations/[organizationIden On Okta, set the following settings: -* Set Audience URI (SP Entity Id) to match the "SP Entity ID" value on Hugging Face. -* Set Name ID format to EmailAddress. -* Under "Show Advanced Settings", verify that Response and Assertion Signature are set to: Signed. - +- Set Audience URI (SP Entity Id) to match the "SP Entity ID" value on Hugging Face. +- Set Name ID format to EmailAddress. +- Under "Show Advanced Settings", verify that Response and Assertion Signature are set to: Signed. Save your new application. ### Step 3: Finalize configuration on Hugging Face In your Okta application, under "Sign On/Settings/More details", find the following fields: + - Sign-on URL - Public certificate - SP Entity ID -You will need them to finalize the SSO setup on Hugging Face. - + You will need them to finalize the SSO setup on Hugging Face.
@@ -94,7 +91,6 @@ You should be redirected to your SSO provider (IdP) login prompt. Once logged in A green check mark near the SAML selector will attest that the test was successful. -
diff --git a/docs/hub/security-sso.md b/docs/hub/security-sso.md index 1ea4a7dde..c3318f2ce 100644 --- a/docs/hub/security-sso.md +++ b/docs/hub/security-sso.md @@ -5,7 +5,7 @@ The Hugging Face Hub gives you the ability to implement mandatory Single Sign-On We support both SAML 2.0 and OpenID Connect (OIDC) protocols. -This feature is part of the Enterprise Hub. +This feature is part of the Enterprise Hub. ## How does it work? @@ -73,12 +73,11 @@ If there is no match, a user will be assigned the default role for your organiza Role synchronization is performed on login. - #### External Collaborators This enables certain users within your organization to access resources without completing the Single Sign-On (SSO) flow described before. This can be helpful when you work with external parties who aren't part of your organization's Identity Provider (IdP) but require access to specific resources. -To add a user as an "External Collaborator" visit the `SSO/Users Management` section in your organization's settings. Once added, these users won't need to go through the SSO process. +To add a user as an "External Collaborator" visit the `SSO/Users Management` section in your organization's settings. Once added, these users won't need to go through the SSO process. -However, they will still be subject to your organization's access controls ([Resource Groups](./security-resource-groups)). +However, they will still be subject to your organization's access controls ([Resource Groups](./security-resource-groups)). It's crucial to manage their access carefully to maintain your organization's data security. diff --git a/docs/hub/spaces-sdks-docker-evidence.md b/docs/hub/spaces-sdks-docker-evidence.md new file mode 100644 index 000000000..3d4867d13 --- /dev/null +++ b/docs/hub/spaces-sdks-docker-evidence.md @@ -0,0 +1,56 @@ +# Evidence on Spaces + +**Evidence** is an open-source framework designed for building data-driven applications, reports, and dashboards using SQL and Markdown. With Evidence, you can quickly create decision-support tools, reports, and interactive dashboards without relying on traditional drag-and-drop business intelligence (BI) platforms. + +Evidence enables you to: +- Write reports and dashboards directly in Markdown with SQL-backed components. +- Integrate data from multiple sources, including SQL databases and APIs. +- Use templated pages to automatically generate multiple pages based on a single template. +- Deploy reports seamlessly to various hosting solutions. + +Visit [Evidence’s documentation](https://docs.evidence.dev/) for guides, examples, and best practices for using Evidence to create data products. + +## Deploy Evidence on Spaces + +You can deploy Evidence on Hugging Face Spaces with just a few clicks: + + + + + +Once created, the Space will display `Building` status. Refresh the page if the status doesn't automatically update to `Running`. + +Your Evidence app will automatically be deployed on Hugging Face Spaces. + +## Editing your Evidence app from the CLI + +To edit your app, clone the Space and edit the files locally. + +```bash +git clone https://huggingface.co/spaces/your-username/your-space-name +cd your-space-name +npm install +npm run sources +npm run dev +``` + +You can then modify pages/index.md to change the content of your app. + +## Editing your Evidence app from VS Code + +The easiest way to develop with Evidence is using the [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=Evidence.evidence-vscode): + +1. Install the extension from the VS Code Marketplace +2. Open the Command Palette (Ctrl/Cmd + Shift + P) and enter `Evidence: Copy Existing Project` +3. Paste the URL of the Hugging Face Spaces Evidence app you'd like to copy (e.g. `https://huggingface.co/spaces/your-username/your-space-name`) and press Enter +4. Select the folder you'd like to clone the project to and press Enter +5. Press `Start Evidence` in the bottom status bar + +Check out the docs for [alternative install methods](https://docs.evidence.dev/getting-started/install-evidence), Github Codespaces, and alongside dbt. + +## Learning More + +- [Docs](https://docs.evidence.dev/) +- [Github](https://github.com/evidence-dev/evidence) +- [Slack Community](https://slack.evidence.dev/) +- [Evidence Home Page](https://www.evidence.dev) \ No newline at end of file diff --git a/docs/hub/spaces-sdks-docker-marimo.md b/docs/hub/spaces-sdks-docker-marimo.md new file mode 100644 index 000000000..01c070fdb --- /dev/null +++ b/docs/hub/spaces-sdks-docker-marimo.md @@ -0,0 +1,64 @@ +# marimo on Spaces + +[marimo](https://github.com/marimo-team/marimo) is a reactive notebook for Python that models notebooks as dataflow graphs. When you run a cell or interact with a UI element, marimo automatically runs affected cells (or marks them as stale), keeping code and outputs consistent and preventing bugs before they happen. Every marimo notebook is stored as pure Python, executable as a script, and deployable as an app. + +Key features: + +- ⚡️ **reactive:** run a cell, and marimo reactively runs all dependent cells or marks them as stale +- 🖐️ **interactive:** bind sliders, tables, plots, and more to Python — no callbacks required +- 🔬 **reproducible:** no hidden state, deterministic execution, built-in package management +- 🏃 **executable:** execute as a Python script, parametrized by CLI args +- 🛜 **shareable:** deploy as an interactive web app or slides, run in the browser via WASM +- 🛢️ **designed for data:** query dataframes and databases with SQL, filter and search dataframes + +## Deploying marimo apps on Spaces + +To get started with marimo on Spaces, click the button below: + + + + + +This will start building your Space using marimo's Docker template. If successful, you should see a similar application to the [marimo introduction notebook](https://huggingface.co/spaces/marimo-team/marimo-app-template). + +## Customizing your marimo app + +When you create a marimo Space, you'll get a few key files to help you get started: + +### 1. app.py + +This is your main marimo notebook file that defines your app's logic. marimo notebooks are pure Python files that use the `@app.cell` decorator to define cells. To learn more about building notebooks and apps, see [the marimo documentation](https://docs.marimo.io). As your app grows, you can organize your code into modules and import them into your main notebook. + +### 2. Dockerfile + +The Dockerfile for a marimo app is minimal since marimo has few system dependencies. The key requirements are: + +- It installs the dependencies listed in `requirements.txt` (using `uv`) +- It creates a non-root user for security +- It runs the app using `marimo run app.py` + +You may need to modify this file if your application requires additional system dependencies, permissions, or other CLI flags. + +### 3. requirements.txt + +The Space will automatically install dependencies listed in the `requirements.txt` file. At minimum, you must include `marimo` in this file. You will want to add any other required packages your app needs. + +The marimo Space template provides a basic setup that you can extend based on your needs. When deployed, your notebook will run in "app mode" which hides the code cells and only shows the interactive outputs - perfect for sharing with end users. You can opt to include the code cells in your app by setting adding `--include-code` to the `marimo run` command in the Dockerfile. + +## Additional Resources and Support + +- [marimo documentation](https://docs.marimo.io) +- [marimo GitHub repository](https://github.com/marimo-team/marimo) +- [marimo Discord](https://marimo.io/discord) +- [marimo template Space](https://huggingface.co/spaces/marimo-team/marimo-app-template) + +## Troubleshooting + +If you encounter issues: + +1. Make sure your notebook runs locally in app mode using `marimo run app.py` +2. Check that all required packages are listed in `requirements.txt` +3. Verify the port configuration matches (7860 is the default for Spaces) +4. Check Space logs for any Python errors + +For more help, visit the [marimo Discord](https://marimo.io/discord) or [open an issue](https://github.com/marimo-team/marimo/issues). diff --git a/docs/hub/storage-regions.md b/docs/hub/storage-regions.md index 8f8b6a0d5..f07882307 100644 --- a/docs/hub/storage-regions.md +++ b/docs/hub/storage-regions.md @@ -1,11 +1,11 @@ # Storage Regions on the Hub -Regions allow you to specify where your organization's models and datasets are stored. - -This feature is part of the Enterprise Hub. +This feature is part of the Enterprise Hub. +Regions allow you to specify where your organization's models and datasets are stored. + This offers two key benefits: - Regulatory and legal compliance @@ -17,11 +17,22 @@ Currently available regions: - EU 🇪🇺 - Coming soon: Asia-Pacific 🌏 -## How to set up - -Organizations subscribed to Enterprise Hub can access the Regions settings page: - -![](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/storage-regions/feature-annotated.png) +## Getting started with Storage Regions + +Organizations subscribed to Enterprise Hub can access the Regions settings page to manage their repositories storage locations. + +
+ screenshot of Hugging Face Storage Regions feature + +
This page displays: @@ -32,8 +43,17 @@ This page displays: Any repository (model or dataset) stored in a non-default location displays its Region as a tag, allowing organization members to quickly identify repository locations. -
- +
+ screenshot of Hugging Face Storage Regions tag feature +
## Regulatory and legal compliance @@ -48,6 +68,17 @@ Storing models and datasets closer to your team and infrastructure significantly This impact is substantial given the typically large size of model weights and dataset files. -![](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/storage-regions/upload-speed.png) +
+ example of Hugging Face Storage Regions feature + +
For example, European users storing repositories in the EU region can expect approximately 4-5x faster upload and download speeds compared to US storage.