Skip to content

Some more outdated client library references #259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Initialize the client library\n",
"## Initialize the ValidMind Library\n",
"\n",
"ValidMind generates a unique _code snippet_ for each registered model to connect with your developer environment. You initialize the client library with this code snippet, which ensures that your documentation and tests are uploaded to the correct model when you run the notebook.\n",
"ValidMind generates a unique _code snippet_ for each registered model to connect with your developer environment. You initialize the ValidMind Library with this code snippet, which ensures that your documentation and tests are uploaded to the correct model when you run the notebook.\n",
"\n",
"### Get your code snippet\n",
"\n",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Initialize the client library\n",
"## Initialize the ValidMind Library\n",
"\n",
"ValidMind generates a unique _code snippet_ for each registered model to connect with your developer environment. You initialize the client library with this code snippet, which ensures that your documentation and tests are uploaded to the correct model when you run the notebook.\n",
"ValidMind generates a unique _code snippet_ for each registered model to connect with your developer environment. You initialize the ValidMind Library with this code snippet, which ensures that your documentation and tests are uploaded to the correct model when you run the notebook.\n",
"\n",
"### Get your code snippet\n",
"\n",
Expand Down
4 changes: 2 additions & 2 deletions notebooks/code_sharing/r/r_customer_churn_demo.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ library(dplyr)
knitr::opts_chunk$set(warning = FALSE, message = FALSE)
```

## **Initializing the ValidMind Client Library**
## **Initializing the ValidMind Library**

Log in to the ValidMind Platform with your registered email address, and navigate to the Documentation Projects page.

Expand All @@ -50,7 +50,7 @@ Select "Customer Churn model" from the Model drop-down, and "Initial Validation"

### **Finding the project API key and secret**

In the "Client Integration" page of the newly created project, you will find the initialization code that allows the client library to associate documentation and tests with the appropriate project. The initialization code configures the following arguments:
In the "Client Integration" page of the newly created project, you will find the initialization code that allows the ValidMind Library to associate documentation and tests with the appropriate project. The initialization code configures the following arguments:

- api_host: Location of the ValidMind API.

Expand Down
4 changes: 2 additions & 2 deletions notebooks/code_sharing/r/r_customer_churn_demo_xgboost.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ library(xgboost)
knitr::opts_chunk$set(warning = FALSE, message = FALSE)
```

## **Initializing the ValidMind Client Library**
## **Initializing the ValidMind Library**

Log in to the ValidMind Platform with your registered email address, and navigate to the Documentation Projects page.

Expand All @@ -51,7 +51,7 @@ Select "Customer Churn model" from the Model drop-down, and "Initial Validation"

### **Finding the project API key and secret**

In the "Client Integration" page of the newly created project, you will find the initialization code that allows the client library to associate documentation and tests with the appropriate project. The initialization code configures the following arguments:
In the "Client Integration" page of the newly created project, you will find the initialization code that allows the ValidMind Library to associate documentation and tests with the appropriate project. The initialization code configures the following arguments:

- api_host: Location of the ValidMind API.

Expand Down
4 changes: 2 additions & 2 deletions notebooks/code_sharing/r/r_mortality_demo.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ custom_print_table_hook <- function(x) {
knitr::knit_hooks$set(print_table = custom_print_table_hook)
```

## **Initializing the ValidMind Client Library**
## **Initializing the ValidMind Library**

Log in to the ValidMind Platform with your registered email address, and
navigate to the Documentation Projects page.
Expand All @@ -137,7 +137,7 @@ Validation" as Type. Finally, click on "Create Project".
### **Finding the project API key and secret**

In the "Client Integration" page of the newly created project, you will
find the initialization code that allows the client library to associate
find the initialization code that allows the ValidMind Library to associate
documentation and tests with the appropriate project. The initialization
code configures the following arguments:

Expand Down
4 changes: 2 additions & 2 deletions notebooks/code_sharing/r/r_time_series_data_validation.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ library(zoo)
knitr::opts_chunk$set(warning = FALSE, message = FALSE)
```

## **Initializing the ValidMind Client Library**
## **Initializing the ValidMind Library**

Log in to the ValidMind Platform with your registered email address, and navigate to the Documentation Projects page.

Expand All @@ -44,7 +44,7 @@ Select "Customer Churn model" from the Model drop-down, and "Initial Validation"

### **Finding the project API key and secret**

In the "Client Integration" page of the newly created project, you will find the initialization code that allows the client library to associate documentation and tests with the appropriate project. The initialization code configures the following arguments:
In the "Client Integration" page of the newly created project, you will find the initialization code that allows the ValidMind Library to associate documentation and tests with the appropriate project. The initialization code configures the following arguments:

- api_host: Location of the ValidMind API.

Expand Down
4 changes: 2 additions & 2 deletions notebooks/code_sharing/r/r_time_series_model_validation.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ custom_print_table_hook <- function(x) {
knitr::knit_hooks$set(print_table = custom_print_table_hook)
```

## Initializing the ValidMind Client Library
## Initializing the ValidMind Library

Log in to the ValidMind Platform with your registered email address, and navigate to the Documentation Projects page.

Expand All @@ -61,7 +61,7 @@ Select "Customer Churn model" from the Model drop-down, and "Initial Validation"

### Finding the project API key and secret

In the "Client Integration" page of the newly created project, you will find the initialization code that allows the client library to associate documentation and tests with the appropriate project. The initialization code configures the following arguments:
In the "Client Integration" page of the newly created project, you will find the initialization code that allows the ValidMind Library to associate documentation and tests with the appropriate project. The initialization code configures the following arguments:

- api_host: Location of the ValidMind API.

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description = "ValidMind Library"
license = "Commercial License"
name = "validmind"
readme = "README.pypi.md"
version = "2.6.6"
version = "2.6.7"

[tool.poetry.dependencies]
python = ">=3.8.1,<3.12"
Expand Down
2 changes: 1 addition & 1 deletion r/validmind/DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Authors@R: c(person("Andres", "Rodriguez", role = c("aut", "cre","cph"),
Maintainer: Andres Rodriguez <andres@validmind.ai>
Description: Deploy, execute, and analyze the results of models hosted on the
'ValidMind' Platform <https://validmind.ai>. This package interfaces with the
'Python' client library in order to allow advanced diagnostics and insight
'Python' Library API in order to allow advanced diagnostics and insight
into trained models all from an 'R' environment.
License: AGPL-3
Encoding: UTF-8
Expand Down
9 changes: 3 additions & 6 deletions validmind/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,13 @@

With a rich array of documentation tools and test suites, from documenting descriptions of your datasets to testing your models for weak spots and overfit areas, the ValidMind Library helps you automate model documentation by feeding the ValidMind Platform with documentation artifacts and test results.

To install the client library:
To install the ValidMind Library:

```bash
pip install validmind
```

To initialize the client library, paste the code snippet with the client integration details directly into your
development source code, replacing this example with your own:
To initialize the ValidMind Library, paste the code snippet with the model identifier credentials directly into your development source code, replacing this example with your own:

```python
import validmind as vm
Expand All @@ -29,9 +28,7 @@
)
```

After you have pasted the code snippet into your development source code and executed the code, the Python client
library will register with ValidMind. You can now use the ValidMind Library to document and test your models,
and to upload to the ValidMind Platform.
After you have pasted the code snippet into your development source code and executed the code, the Python Library API will register with ValidMind. You can now use the ValidMind Library to document and test your models, and to upload to the ValidMind Platform.
"""
import warnings

Expand Down
2 changes: 1 addition & 1 deletion validmind/__version__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "2.6.6"
__version__ = "2.6.7"
Loading