Skip to content

Commit

Permalink
docs: move breaking changes
Browse files Browse the repository at this point in the history
  • Loading branch information
DeepPavlovAdmin committed Jul 1, 2019
1 parent e67b111 commit 66769c5
Showing 1 changed file with 33 additions and 31 deletions.
64 changes: 33 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,10 @@ DeepPavlov is an open-source conversational AI library built on [TensorFlow](htt
* development of production ready chat-bots and complex conversational systems,
* NLP and dialog systems research.

### Demo
## Demo

Demo of selected features is available at [demo.ipavlov.ai](https://demo.ipavlov.ai/)


### Breaking changes in version 0.4.0!
- default target variable name for [neural evolution](https://docs.deeppavlov.ai/en/0.4.0/intro/hypersearch.html#parameters-evolution-for-deeppavlov-models)
was changed from `MODELS_PATH` to `MODEL_PATH`.

### Breaking changes in version 0.3.0!
- component option `fit_on_batch` in configuration files was removed and replaced with adaptive usage of the `fit_on` parameter.

### Breaking changes in version 0.2.0!
- `utils` module was moved from repository root in to `deeppavlov` module
- `ms_bot_framework_utils`,`server_utils`, `telegram utils` modules was renamed to `ms_bot_framework`, `server` and `telegram` correspondingly
- rename metric functions `exact_match` to `squad_v2_em` and `squad_f1` to `squad_v2_f1`
- replace dashes in configs name with underscores

### Breaking changes in version 0.1.0!
- As of `version 0.1.0` all models, embeddings and other downloaded data for provided configurations are
by default downloaded to the `.deeppavlov` directory in current user's home directory.
This can be changed on per-model basis by modifying
a `ROOT_PATH` [variable](http://docs.deeppavlov.ai/en/latest/intro/config_description.html#variables)
or related fields one by one in model's configuration file.

- In configuration files, for all components, dataset readers and iterators `"name"` and `"class"` fields are combined
into the `"class_name"` field.

- `deeppavlov.core.commands.infer.build_model_from_config()` was renamed to `build_model` and can be imported from the
`deeppavlov` module directly.

- The way arguments are passed to metrics functions during training and evaluation was changed and
[documented](http://docs.deeppavlov.ai/en/latest/intro/config_description.html#metrics).

# Hello Bot in DeepPavlov

Import key components to build HelloBot.
Expand Down Expand Up @@ -170,6 +140,38 @@ Every line of input text will be used as a pipeline input parameter, so one exam
as many input parameters your pipeline expects.
You can also specify batch size with `-b` or `--batch-size` parameter.

# Breaking changes

## Breaking changes in version 0.4.0!
- default target variable name for [neural evolution](https://docs.deeppavlov.ai/en/0.4.0/intro/hypersearch.html#parameters-evolution-for-deeppavlov-models)
was changed from `MODELS_PATH` to `MODEL_PATH`.

## Breaking changes in version 0.3.0!
- component option `fit_on_batch` in configuration files was removed and replaced with adaptive usage of the `fit_on` parameter.

## Breaking changes in version 0.2.0!
- `utils` module was moved from repository root in to `deeppavlov` module
- `ms_bot_framework_utils`,`server_utils`, `telegram utils` modules was renamed to `ms_bot_framework`, `server` and `telegram` correspondingly
- rename metric functions `exact_match` to `squad_v2_em` and `squad_f1` to `squad_v2_f1`
- replace dashes in configs name with underscores

## Breaking changes in version 0.1.0!
- As of `version 0.1.0` all models, embeddings and other downloaded data for provided configurations are
by default downloaded to the `.deeppavlov` directory in current user's home directory.
This can be changed on per-model basis by modifying
a `ROOT_PATH` [variable](http://docs.deeppavlov.ai/en/latest/intro/config_description.html#variables)
or related fields one by one in model's configuration file.

- In configuration files, for all components, dataset readers and iterators `"name"` and `"class"` fields are combined
into the `"class_name"` field.

- `deeppavlov.core.commands.infer.build_model_from_config()` was renamed to `build_model` and can be imported from the
`deeppavlov` module directly.

- The way arguments are passed to metrics functions during training and evaluation was changed and
[documented](http://docs.deeppavlov.ai/en/latest/intro/config_description.html#metrics).


# Documentation

[docs.deeppavlov.ai](http://docs.deeppavlov.ai/)
Expand Down

0 comments on commit 66769c5

Please sign in to comment.