Skip to content
This repository has been archived by the owner on Jul 15, 2022. It is now read-only.

Commit

Permalink
v3.3.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
dcfidalgo committed Sep 8, 2021
1 parent f958cf2 commit bb9e35b
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 64 deletions.
6 changes: 3 additions & 3 deletions docs/docs/.vuepress/theme/styles/fonts.styl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
font-family: 'Basis Grotesque Pro'
font-style: normal
font-weight: normal
src: local('Basis Grotesque Pro'), url('/biome-text/master/assets/fonts/BasisGrotesquePro-Regular.woff') format('woff')
src: local('Basis Grotesque Pro'), url('/biome-text/v3.3.0/assets/fonts/BasisGrotesquePro-Regular.woff') format('woff')


@font-face
font-family: 'Basis Grotesque Pro Bold'
font-style: normal
font-weight: normal
src: local('Basis Grotesque Pro Bold'), url('/biome-text/master/assets/fonts/BasisGrotesquePro-Bold.woff') format('woff')
src: local('Basis Grotesque Pro Bold'), url('/biome-text/v3.3.0/assets/fonts/BasisGrotesquePro-Bold.woff') format('woff')


@font-face
font-family: 'Basis Grotesque Pro Light'
font-style: normal
font-weight: normal
src: local('Basis Grotesque Pro Light'), url('/biome-text/master/assets/fonts/BasisGrotesquePro-Light.woff') format('woff')
src: local('Basis Grotesque Pro Light'), url('/biome-text/v3.3.0/assets/fonts/BasisGrotesquePro-Light.woff') format('woff')
32 changes: 16 additions & 16 deletions docs/docs/documentation/tutorials/1-Training_a_text_classifier.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"<a target=\"_blank\" href=\"https://recognai.github.io/biome-text/master/documentation/tutorials/1-Training_a_text_classifier.html\"><img class=\"icon\" src=\"https://recognai.github.io/biome-text/master/assets/img/biome-isotype.svg\" width=24 /></a>\n",
"[View on recogn.ai](https://https://recognai.github.io/biome-text/master/documentation/tutorials/1-Training_a_text_classifier.html)\n",
"<a target=\"_blank\" href=\"https://recognai.github.io/biome-text/v3.3.0/documentation/tutorials/1-Training_a_text_classifier.html\"><img class=\"icon\" src=\"https://recognai.github.io/biome-text/v3.3.0/assets/img/biome-isotype.svg\" width=24 /></a>\n",
"[View on recogn.ai](https://https://recognai.github.io/biome-text/v3.3.0/documentation/tutorials/1-Training_a_text_classifier.html)\n",
"\n",
"<a target=\"_blank\" href=\"https://colab.research.google.com/github/recognai/biome-text/blob/master/docs/docs/documentation/tutorials/1-Training_a_text_classifier.ipynb\"><img class=\"icon\" src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" width=24 /></a>\n",
"[Run in Google Colab](https://colab.research.google.com/github/recognai/biome-text/blob/master/docs/docs/documentation/tutorials/1-Training_a_text_classifier.ipynb)\n",
"<a target=\"_blank\" href=\"https://colab.research.google.com/github/recognai/biome-text/blob/v3.3.0/docs/docs/documentation/tutorials/1-Training_a_text_classifier.ipynb\"><img class=\"icon\" src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" width=24 /></a>\n",
"[Run in Google Colab](https://colab.research.google.com/github/recognai/biome-text/blob/v3.3.0/docs/docs/documentation/tutorials/1-Training_a_text_classifier.ipynb)\n",
"\n",
"<a target=\"_blank\" href=\"https://github.com/recognai/biome-text/blob/master/docs/docs/documentation/tutorials/1-Training_a_text_classifier.ipynb\"><img class=\"icon\" src=\"https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png\" width=24 /></a>\n",
"[View source on GitHub](https://github.com/recognai/biome-text/blob/master/docs/docs/documentation/tutorials/1-Training_a_text_classifier.ipynb)"
"<a target=\"_blank\" href=\"https://github.com/recognai/biome-text/blob/v3.3.0/docs/docs/documentation/tutorials/1-Training_a_text_classifier.ipynb\"><img class=\"icon\" src=\"https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png\" width=24 /></a>\n",
"[View source on GitHub](https://github.com/recognai/biome-text/blob/v3.3.0/docs/docs/documentation/tutorials/1-Training_a_text_classifier.ipynb)"
]
},
{
Expand All @@ -35,7 +35,7 @@
"outputs": [],
"source": [
"!pip install -U pip\n",
"!pip install -U git+https://github.com/recognai/biome-text.git\n",
"!pip install -U biome-text\n",
"exit(0) # Force restart of the runtime"
]
},
Expand Down Expand Up @@ -91,7 +91,7 @@
"source": [
"## Explore the training data\n",
"\n",
"Let's take a look at the data we will use for training. For this we will use the [`Dataset`](https://recognai.github.io/biome-text/master/api/biome/text/dataset.html#dataset) class that is a very thin wrapper around HuggingFace's awesome [datasets.Dataset](https://huggingface.co/docs/datasets/master/package_reference/main_classes.html#datasets.Dataset).\n",
"Let's take a look at the data we will use for training. For this we will use the [`Dataset`](https://recognai.github.io/biome-text/v3.3.0/api/biome/text/dataset.html#dataset) class that is a very thin wrapper around HuggingFace's awesome [datasets.Dataset](https://huggingface.co/docs/datasets/master/package_reference/main_classes.html#datasets.Dataset).\n",
"We will download the data first to create `Dataset` instances.\n",
"\n",
"Apart from the training data we will also download an optional validation data set to estimate the generalization error."
Expand Down Expand Up @@ -157,7 +157,7 @@
"source": [
"::: tip Tip\n",
"\n",
"The [TaskHead](https://recognai.github.io/biome-text/master/api/biome/text/modules/heads/task_head.html#taskhead) of our model below will expect a *text* and a *label* column to be present in the `Dataset`. In our data set this is already the case, otherwise we would need to change or map the corresponding column names via `Dataset.rename_column_()` or `Dataset.map()`.\n",
"The [TaskHead](https://recognai.github.io/biome-text/v3.3.0/api/biome/text/modules/heads/task_head.html#taskhead) of our model below will expect a *text* and a *label* column to be present in the `Dataset`. In our data set this is already the case, otherwise we would need to change or map the corresponding column names via `Dataset.rename_column_()` or `Dataset.map()`.\n",
"\n",
":::"
]
Expand Down Expand Up @@ -196,12 +196,12 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"A typical [Pipeline](https://recognai.github.io/biome-text/master/api/biome/text/pipeline.html#pipeline) consists of tokenizing the input, extracting features, applying a language encoding (optionally) and executing a task-specific head in the end.\n",
"A typical [Pipeline](https://recognai.github.io/biome-text/v3.3.0/api/biome/text/pipeline.html#pipeline) consists of tokenizing the input, extracting features, applying a language encoding (optionally) and executing a task-specific head in the end.\n",
"\n",
"After training a pipeline, you can use it to make predictions.\n",
"\n",
"As a first step we must define a configuration for our pipeline. \n",
"In this tutorial we will create a configuration dictionary and use the `Pipeline.from_config()` method to create our pipeline, but there are [other ways](https://recognai.github.io/biome-text/master/api/biome/text/pipeline.html#pipeline).\n",
"In this tutorial we will create a configuration dictionary and use the `Pipeline.from_config()` method to create our pipeline, but there are [other ways](https://recognai.github.io/biome-text/v3.3.0/api/biome/text/pipeline.html#pipeline).\n",
"\n",
"A *biome.text* pipeline has the following main components:\n",
"\n",
Expand All @@ -218,7 +218,7 @@
"\n",
"```\n",
"\n",
"See the [Configuration section](https://recognai.github.io/biome-text/master/documentation/user-guides/2-configuration.html) for a detailed description of how these main components can be configured.\n",
"See the [Configuration section](https://recognai.github.io/biome-text/v3.3.0/documentation/user-guides/2-configuration.html) for a detailed description of how these main components can be configured.\n",
"\n",
"Our complete configuration for this tutorial will be following:"
]
Expand Down Expand Up @@ -297,9 +297,9 @@
"The default behavior of *biome.text* is to add all tokens from the training data set to the pipeline's vocabulary. \n",
"This is done automatically when training the pipeline for the first time.\n",
"\n",
"If you want to have more control over this step, you can define a `VocabularyConfiguration` and pass it to the [`Trainer`](https://recognai.github.io/biome-text/master/api/biome/text/trainer.html) later on.\n",
"If you want to have more control over this step, you can define a `VocabularyConfiguration` and pass it to the [`Trainer`](https://recognai.github.io/biome-text/v3.3.0/api/biome/text/trainer.html) later on.\n",
"In our business name classifier we only want to include words with a general meaning to our word feature vocabulary (like \"Computer\" or \"Autohaus\", for example), and want to exclude specific names that will not help to generally classify the kind of business.\n",
"This can be achieved by including only the most frequent words in our training set via the `min_count` argument. For a complete list of available arguments see the [VocabularyConfiguration API](https://recognai.github.io/biome-text/master/api/biome/text/configuration.html#vocabularyconfiguration)."
"This can be achieved by including only the most frequent words in our training set via the `min_count` argument. For a complete list of available arguments see the [VocabularyConfiguration API](https://recognai.github.io/biome-text/v3.3.0/api/biome/text/configuration.html#vocabularyconfiguration)."
]
},
{
Expand All @@ -317,12 +317,12 @@
"source": [
"## Configure the trainer\n",
"\n",
"As a next step we have to configure the [`Trainer`](https://recognai.github.io/biome-text/master/api/biome/text/trainer.html), which in essentially is a light wrapper around the amazing [Pytorch Lightning Trainer](https://pytorch-lightning.readthedocs.io/en/latest/common/trainer.html).\n",
"As a next step we have to configure the [`Trainer`](https://recognai.github.io/biome-text/v3.3.0/api/biome/text/trainer.html), which in essentially is a light wrapper around the amazing [Pytorch Lightning Trainer](https://pytorch-lightning.readthedocs.io/en/latest/common/trainer.html).\n",
"\n",
"The default trainer has sensible defaults and should work alright for most of your cases.\n",
"In this tutorial, however, we want to tune a bit the learning rate and limit the training time to three epochs only.\n",
"We also want to modify the monitored validation metric (by default it is the `validation_loss`) that is used to rank the checkpoints, as well as for the early stopping mechanism and to load the best model weights at the end of the training.\n",
"For a complete list of available arguments see the [TrainerConfiguration API](https://recognai.github.io/biome-text/master/api/biome/text/configuration.html#trainerconfiguration).\n",
"For a complete list of available arguments see the [TrainerConfiguration API](https://recognai.github.io/biome-text/v3.3.0/api/biome/text/configuration.html#trainerconfiguration).\n",
"\n",
"::: tip Tip\n",
"\n",
Expand Down
Loading

0 comments on commit bb9e35b

Please sign in to comment.