diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..3f9fe2e --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,27 @@ +cff-version: 1.2.0 +message: "If you use Model2Vec in your research, please cite it as below." +title: "Model2Vec: Fast State-of-the-Art Static Embeddings" +authors: + - family-names: "Tulkens" + given-names: "Stephan" + - family-names: "van Dongen" + given-names: "Thomas" +doi: 10.5281/zenodo.17270888 +license: MIT +url: "https://github.com/MinishLab/model2vec" +repository-code: "https://github.com/MinishLab/model2vec-rs" +date-released: "2024-09-20" + +preferred-citation: + type: software + title: "Model2Vec: Fast State-of-the-Art Static Embeddings" + authors: + - family-names: "Tulkens" + given-names: "Stephan" + - family-names: "van Dongen" + given-names: "Thomas" + year: 2024 + publisher: Zenodo + doi: 10.5281/zenodo.17270888 + url: "https://github.com/MinishLab/model2vec" + license: MIT diff --git a/Cargo.toml b/Cargo.toml index 5094df2..5772202 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -11,7 +11,7 @@ repository = "https://github.com/MinishLab/model2vec-rs" keywords = ["embeddings", "model2vec", "nlp", "rust"] categories = ["science", "text-processing"] -exclude = ["tests/*"] +exclude = ["tests/*", "assets/*", "local/*"] [features] default = ["onig", "hf-hub"] diff --git a/README.md b/README.md index 8cbe4f6..ecbbdbf 100644 --- a/README.md +++ b/README.md @@ -209,12 +209,15 @@ MIT ## Citing Model2Vec -If you use the Model2Vec methodology or models in your research or work, please cite the original Model2Vec project: +If you use Model2Vec in your research, please cite the following: ```bibtex -@article{minishlab2024model2vec, - author = {Tulkens, Stephan and {van Dongen}, Thomas}, - title = {Model2Vec: Fast State-of-the-Art Static Embeddings}, - year = {2024}, - url = {https://github.com/MinishLab/model2vec} +@software{minishlab2024model2vec, + author = {Stephan Tulkens and {van Dongen}, Thomas}, + title = {Model2Vec: Fast State-of-the-Art Static Embeddings}, + year = {2024}, + publisher = {Zenodo}, + doi = {10.5281/zenodo.17270888}, + url = {https://github.com/MinishLab/model2vec}, + license = {MIT} } ```