Knowledge centre environments

Knowledge centre environments allow you to share Faculty platform environments with other data scientists in your organisation.

The Knowledge centre contains two types of environments:

  • Environments created and managed by users.

  • Faculty-defined environments.

User-defined environments can be used and updated by Full Users of your platform deployment. Typically, this will correspond to data scientists within your organisation.

Faculty-defined environments are environments that come with the Platform. They aim to teach you how to customise your servers for common use cases. Their name ends with by Faculty.

Using Knowledge centre environments

To use an environment in the Knowledge centre, you need to add it to to your project. Once the environment is in your project, you can apply it to your servers, app, API and job definitions.

Note

The project environment is independent of the Knowledge centre environment it came from. New versions of the Knowledge centre environment will not affect the project environment and, conversely, you can edit or delete the project environment without altering the Knowledge centre environment it came from.

Publishing new environments to the Knowledge centre

Any Full User can create new environments in the Knowledge centre, or publish a new version of an existing environment.

To create a new environment in the Knowledge centre:

  1. Create an environment in a project and update the System, Python, and Scripts sections as needed.

  2. Click on the Publish button. You will be prompted for a name and a description. You can edit the description further once it is published.

  1. You can make changes to the description once it is published. The description supports Markdown. We recommend that you include code snippets or examples relevant to using the environment.

Updating environments in the Knowledge centre

Any Full User can update a Knowledge centre environment. These environments are versioned, so changes you make are tracked.

To update an existing environment in the Knowledge centre:

  1. Add it to a project.

  2. Make changes to the environment definition in the project. Test those changes by applying the environment to a server.

  3. Once you are satisfied with the new environment, click on ‘Publish’. In the modal, select the name of the Knowledge centre environment you want to update. This will publish a new version of the environment.