diff --git a/CHANGELOG.md b/CHANGELOG.md index 3970f0dac35..6ecfd9c7952 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## Unreleased +### Added + +- Adds [`allennlp-semparse`](https://github.com/allenai/allennlp-semparse) as an official, default plugin. + ### Fixed - `GumbelSampler` now sorts the beams by their true log prob. diff --git a/README.md b/README.md index df214f0f1ab..f3eb9a05a8a 100644 --- a/README.md +++ b/README.md @@ -65,12 +65,46 @@ And others on the [AI2 AllenNLP blog](https://medium.com/ai2-blog/allennlp/home) AllenNLP supports loading "plugins" dynamically. A plugin is just a Python package that provides custom registered classes or additional `allennlp` subcommands. -There are several official [default plugins](https://docs.allennlp.org/master/api/common/plugins/#default_plugins) and an ecosystem of third-party plugins, including: +There is ecosystem of open source plugins, some of which are maintained by the AllenNLP +team here at AI2, and some of which are maintained by the broader community. -* [allennlp-optuna](https://github.com/himkt/allennlp-optuna) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Plugin Maintainer CLI Description
allennlp-models AI2 No A collection of state-of-the-art models
allennlp-semparse AI2 No A framework for building semantic parsers
allennlp-server AI2 Yes A simple demo server for serving models
allennlp-optuna Makoto Hiramatsu Yes Optuna integration for hyperparameter optimization
-In order for AllenNLP to find personal or third-party plugins, you have to create either a local plugins file named `.allennlp_plugins` -in the directory where the `allennlp` command is run, or a global plugins file at `~/.allennlp/plugins`. +AllenNLP will automatically find any official AI2-maintained plugins that you have installed, +but for AllenNLP to find personal or third-party plugins you've installed, +you also have to create either a local plugins file named `.allennlp_plugins` +in the directory where you run the `allennlp` command, or a global plugins file at `~/.allennlp/plugins`. The file should list the plugin modules that you want to be loaded, one per line. To test that your plugins can be found and imported by AllenNLP, you can run the `allennlp test-install` command. @@ -84,31 +118,31 @@ to distribute as a plugin, see the [subcommand API docs](https://docs.allennlp.o - + - + - - + + - - + + - + - + - +
allennlp an open-source NLP research library, built on PyTorch An open-source NLP research library, built on PyTorch
allennlp.commands functionality for a CLI and web service Functionality for the CLI
allennlp.data a data processing module for loading datasets and encoding strings as integers for representation in matrices allennlp.common Utility modules that are used across the library
allennlp.models a collection of state-of-the-art models allennlp.data A data processing module for loading datasets and encoding strings as integers for representation in matrices
allennlp.modules a collection of PyTorch modules for use with text A collection of PyTorch modules for use with text
allennlp.nn tensor utility functions, such as initializers and activation functions Tensor utility functions, such as initializers and activation functions
allennlp.training functionality for training models Functionality for training models
diff --git a/allennlp/common/plugins.py b/allennlp/common/plugins.py index 56202f08160..d0361729430 100644 --- a/allennlp/common/plugins.py +++ b/allennlp/common/plugins.py @@ -33,7 +33,7 @@ The global plugins file will be found here. """ -DEFAULT_PLUGINS = ("allennlp_models", "allennlp_server") +DEFAULT_PLUGINS = ("allennlp_models", "allennlp_semparse", "allennlp_server") """ Default plugins do not need to be declared in a plugins file. They will always be imported when they are installed in the current Python environment.