Struct NERModel

Source
pub struct NERModel { /* private fields */ }
Expand description

§NERModel to extract named entities

Implementations§

Source§

impl NERModel

Source

pub fn new( ner_config: TokenClassificationConfig, ) -> Result<NERModel, RustBertError>

Build a new NERModel

§Arguments
  • ner_config - NERConfig object containing the resource references (model, vocabulary, configuration) and device placement (CPU/GPU)
§Example
use rust_bert::pipelines::ner::NERModel;

let ner_model = NERModel::new(Default::default())?;
Source

pub fn new_with_tokenizer( ner_config: TokenClassificationConfig, tokenizer: TokenizerOption, ) -> Result<NERModel, RustBertError>

Build a new NERModel with a provided tokenizer.

§Arguments
  • ner_config - NERConfig object containing the resource references (model, vocabulary, configuration) and device placement (CPU/GPU)
  • tokenizer - TokenizerOption tokenizer to use for token classification
§Example
use rust_bert::pipelines::common::{ModelType, TokenizerOption};
use rust_bert::pipelines::ner::NERModel;
let tokenizer = TokenizerOption::from_file(
    ModelType::Bert,
    "path/to/vocab.txt",
    None,
    false,
    None,
    None,
)?;
let ner_model = NERModel::new_with_tokenizer(Default::default(), tokenizer)?;
Source

pub fn get_tokenizer(&self) -> &TokenizerOption

Get a reference to the model tokenizer.

Source

pub fn get_tokenizer_mut(&mut self) -> &mut TokenizerOption

Get a mutable reference to the model tokenizer.

Source

pub fn predict<S>(&self, input: &[S]) -> Vec<Vec<Entity>>
where S: AsRef<str>,

Extract entities from a text

§Arguments
  • input - &[&str] Array of texts to extract entities from.
§Returns
  • Vec<Vec<Entity>> containing extracted entities
§Example

let ner_model = NERModel::new(Default::default())?;
let input = [
    "My name is Amy. I live in Paris.",
    "Paris is a city in France.",
];
let output = ner_model.predict(&input);
Source

pub fn predict_full_entities<S>(&self, input: &[S]) -> Vec<Vec<Entity>>
where S: AsRef<str>,

Extract full entities from a text performing entity chunking. Follows the algorithm for entities chunking described in Erik F. Tjong Kim Sang, Jorn Veenstra, Representing Text Chunks The proposed implementation is inspired by the Python seqeval library (shared under MIT license).

§Arguments
  • input - &[&str] Array of texts to extract entities from.
§Returns
  • Vec<Entity> containing consolidated extracted entities
§Example

let ner_model = NERModel::new(Default::default())?;
let input = ["Asked John Smith about Acme Corp"];
let output = ner_model.predict_full_entities(&input);

Outputs:

Output: \

[[
    Entity {
        word: String::from("John Smith"),
        score: 0.9747,
        label: String::from("PER"),
        offset: Offset { begin: 6, end: 16 },
    },
    Entity {
        word: String::from("Acme Corp"),
        score: 0.8847,
        label: String::from("I-LOC"),
        offset: Offset { begin: 23, end: 32 },
    },
]]

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T