{"id":15620667,"url":"https://github.com/akb89/noframenet","last_synced_at":"2026-02-12T16:31:32.254Z","repository":{"id":73382475,"uuid":"70735013","full_name":"akb89/noframenet","owner":"akb89","description":"A set of scripts to import FrameNet XML data to a MongoDB database","archived":false,"fork":false,"pushed_at":"2018-08-31T14:13:05.000Z","size":405,"stargazers_count":3,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-02T10:42:10.612Z","etag":null,"topics":["framenet","framenet-xml-data","import","mongodb"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/akb89.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-10-12T19:38:45.000Z","updated_at":"2023-04-18T18:08:01.000Z","dependencies_parsed_at":"2023-04-08T21:00:51.062Z","dependency_job_id":null,"html_url":"https://github.com/akb89/noframenet","commit_stats":{"total_commits":168,"total_committers":3,"mean_commits":56.0,"dds":0.5059523809523809,"last_synced_commit":"91f6fafd2355ddaf0182d8c33be2bd5bf27dba01"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/akb89/noframenet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akb89%2Fnoframenet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akb89%2Fnoframenet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akb89%2Fnoframenet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akb89%2Fnoframenet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akb89","download_url":"https://codeload.github.com/akb89/noframenet/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akb89%2Fnoframenet/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29372182,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-12T08:51:36.827Z","status":"ssl_error","status_checked_at":"2026-02-12T08:51:26.849Z","response_time":55,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["framenet","framenet-xml-data","import","mongodb"],"created_at":"2024-10-03T09:01:55.758Z","updated_at":"2026-02-12T16:31:32.231Z","avatar_url":"https://github.com/akb89.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NoFrameNet\n[![GitHub release][release-image]][release-url]\n[![Build][travis-image]][travis-url]\n[![Dependencies][david-dep-image]][david-url]\n[![DevDependencies][david-dev-dep-image]][david-dev-url]\n[![MIT License][license-image]][license-url]\n[![FrameNet][framenet-image]][framenet-url]\n\nOpinionated import of FrameNet XML data to MongoDB\n\n## Requirements\nYou need to have [Mongo](https://docs.mongodb.com/manual/administration/install-community/), [Node and npm](https://nodejs.org/en/download/) installed on your system.\nNoFrameNet should work on Node v6.9.2 and above, npm v3.10.9 and above and mongo v3.2.9 and above. Earlier versions may work as well but we haven't tested them.\n\n## Import\nTo import FrameNet XML data to MongoDB\n\n### 1. Download [FrameNet XML data](https://framenet.icsi.berkeley.edu/fndrupal/framenet_request_data)\n### 2. Download [NoFrameNet](https://github.com/akb89/noframenet/releases/latest)\n### 3. Install the required dependencies\nRun the following command in your terminal, under the NoFrameNet directory:\n```\nnpm install\n```\n### 4. Set-up the configuration\nModify the `config/production.js` file\n```\nconst config = {\n  dbUri: 'mongodb://localhost:27017/fn_en_170',\n  logger: logger.info,\n  frameNetDir: '/Users/AKB/Dropbox/FrameNetData/fndata-1.7',\n  splitsDir: '/Users/AKB/Dropbox/FrameNetData/fndata-1.7',\n  importLexUnits: true,\n  importFullTexts: true,\n  importHierarchy: true,\n  frameChunkSize: 150,\n  lexUnitChunkSize: 200,\n};\n```\nThe `frameNetDir` parameter should refer to the absolute path of the unzipped FrameNet data directory.\n\nYou can tweak the `frameChunkSize` and `lexUnitChunkSize`parameters to improve import speed by specifying how many frame or lexunit files should be processed at once.\n\nSet `importLexUnits` to `true` if you wish to import the content of the `lu` dir. Set `importFullTexts` to `true` if you wish to important the content of the `fulltext` dir. Set `importHierarchy` to `true` if you wish to import a\nformatted collection of FrameNet Frame and FE hierarchies, as used by\nthe [Valencer API](http://www.github.io/akb89/valencer).\n\nSpecify a different `splitsDir` parameter if you want to split FrameNet files into train/dev/test directories and import only a specific dir.\nYour frameNetDir should have the following structure:\n```\n.\n|-- frameNetDir\n|   |-- frame\n|   |   |-- Abandonment.xml\n|   |   |-- ...\n|   |-- frRelation.xml\n|   |-- train\n|   |   |-- fulltext\n|   |   |   |-- corpusNameXYZ__123.xml\n|   |   |   |-- ...\n|   |   |-- lu\n|   |   |   |-- luFile.xml\n|   |   |   |-- ...\n|   |-- dev\n|   |   |-- fulltext\n|   |   |   |-- corpusNameXYZ__123.xml\n|   |   |   |-- ...\n|   |   |-- lu\n|   |   |   |-- luFile.xml\n|   |   |   |-- ...\n|   |-- test\n|   |   |-- fulltext\n|   |   |   |-- corpusNameXYZ__123.xml\n|   |   |   |-- ...\n|   |   |-- lu\n|   |   |   |-- luFile.xml\n|   |   |   |-- ...\n```\n\n### 5. Start the full import process\nRun the following command in your terminal, under the NoFrameNet directory:\n```\nnpm run import\n```\n\nThe import process usually takes about 20min to 30min in total (tested on a MacBook Pro with 2,8 GHz Intel Core i5 and 8 GB 1600 MHz DDR3)\n\n## Data Fix\n### Wrong Phrase Type\nIn Sentence#1492916 , _'Before his death Edward IV had also initiated military activity against France , following Louis XI 's renunciation of some of the key terms of the 1475 treaty of Picquigny .'_, the Phrase Type of the 'Activity' frame element corresponding to the 'initiate.v' lexical unit is mistakenly marked as an 'Obj'.\nData are fixed automatically after import via the `fix` script.\n\n## Models\nDetails about the underlying Mongoose models can be found on [NoFrameNet-Core](https://github.com/akb89/noframenet-core)\n\n## FrameNet Version Compatibility\nNoFrameNet has been tested on FrameNet:\n- 1.5\n- 1.6\n- 1.7\n\n## Format of FrameNet XML data\nNoFrameNet expects FrameNet XML data to follow the Berkeley FrameNet XML format.\nXML documents should therefore follow:\n\nEither the `fulltext` format structured as:\n```xml\n\u003c?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?\u003e\n\u003c?xml-stylesheet type=\"text/xsl\" href=\"fullText.xsl\"?\u003e\n\u003cfullTextAnnotation xsi:schemaLocation=\"../schema/fullText.xsd\" xmlns=\"http://framenet.icsi.berkeley.edu\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\u003e\n    \u003cheader\u003e\n        \u003ccorpus description=\"American National Corpus Texts\" name=\"ANC\" ID=\"195\"\u003e\n            \u003cdocument description=\"Goodwill fund-raising letter\" name=\"110CYL067\" ID=\"23791\"/\u003e\n        \u003c/corpus\u003e\n    \u003c/header\u003e\n    \u003csentence corpID=\"195\" docID=\"23791\" sentNo=\"1\" paragNo=\"1\" aPos=\"0\" ID=\"4106338\"\u003e\n        \u003ctext\u003eDecember 1998\u003c/text\u003e\n        \u003cannotationSet cDate=\"12/08/2010 04:12:18 PST Wed\" luID=\"4654\" luName=\"December.n\" frameID=\"229\" frameName=\"Calendric_unit\" status=\"MANUAL\" ID=\"6559768\"\u003e\n            \u003clayer rank=\"1\" name=\"Target\"\u003e\n                \u003clabel cBy=\"MLC\" end=\"7\" start=\"0\" name=\"Target\"/\u003e\n            \u003c/layer\u003e\n            \u003clayer rank=\"1\" name=\"FE\"\u003e\n                \u003clabel cBy=\"MLC\" feID=\"10331\" bgColor=\"FF0000\" fgColor=\"FFFFFF\" end=\"7\" start=\"0\" name=\"Unit\"/\u003e\n                \u003clabel cBy=\"MLC\" feID=\"2016\" bgColor=\"FF69B4\" fgColor=\"FFFFFF\" end=\"12\" start=\"9\" name=\"Whole\"/\u003e\n            \u003c/layer\u003e\n            \u003clayer rank=\"1\" name=\"GF\"\u003e\n                \u003clabel end=\"12\" start=\"9\" name=\"Dep\"/\u003e\n            \u003c/layer\u003e\n            \u003clayer rank=\"1\" name=\"PT\"\u003e\n                \u003clabel end=\"12\" start=\"9\" name=\"NP\"/\u003e\n            \u003c/layer\u003e\n            \u003clayer rank=\"1\" name=\"Other\"/\u003e\n            \u003clayer rank=\"1\" name=\"Sent\"/\u003e\n            \u003clayer rank=\"1\" name=\"Noun\"/\u003e\n        \u003c/annotationSet\u003e\n        ...\n```\n\nEither the `lexicographic` format structured as:\n```xml\n\u003c?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?\u003e\n\u003c?xml-stylesheet type=\"text/xsl\" href=\"lexUnit.xsl\"?\u003e\n\u003clexUnit status=\"Finished_Initial\" POS=\"V\" name=\"cause.v\" ID=\"2\" frame=\"Causation\" frameID=\"5\" totalAnnotated=\"116\" xsi:schemaLocation=\"../schema/lexUnit.xsd\" xmlns=\"http://framenet.icsi.berkeley.edu\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\u003e\n    \u003cheader\u003e\n        \u003ccorpus description=\"BNC2\" name=\"BNC2\" ID=\"111\"\u003e\n            \u003cdocument description=\"bncp\" name=\"bncp\" ID=\"421\"/\u003e\n            ...\n        \u003c/corpus\u003e\n        ...\n        \u003cframe\u003e\n            \u003cFE fgColor=\"FFFFFF\" bgColor=\"1E90FF\" type=\"Core\" abbrev=\"act\" name=\"Actor\"/\u003e\n            ...\n        \u003c/frame\u003e\n    \u003c/header\u003e\n    \u003cdefinition\u003eCOD: be the cause of; make happen. \u003c/definition\u003e\n    \u003clexeme POS=\"V\" name=\"cause\"/\u003e\n    \u003csubCorpus name=\"V-429-s20-rcoll-change\"\u003e\n      \u003csentence sentNo=\"0\" aPos=\"20224298\" ID=\"651966\"\u003e\n        \u003ctext\u003eIrreversible cell expansion -- very rapid growth -- caused the movement , not turgor change . \u003c/text\u003e\n        \u003cannotationSet cDate=\"01/07/2003 09:27:03 PST Tue\" status=\"MANUAL\" ID=\"784400\"\u003e\n            \u003clayer rank=\"1\" name=\"FE\"\u003e\n                \u003clabel cBy=\"Pam\" feID=\"18\" end=\"47\" start=\"0\" name=\"Cause\"/\u003e\n                \u003clabel cBy=\"Pam\" feID=\"20\" end=\"70\" start=\"59\" name=\"Effect\"/\u003e\n            \u003c/layer\u003e\n            \u003clayer rank=\"1\" name=\"GF\"\u003e\n                \u003clabel end=\"47\" start=\"0\" name=\"Ext\"/\u003e\n                \u003clabel end=\"70\" start=\"59\" name=\"Obj\"/\u003e\n            \u003c/layer\u003e\n            \u003clayer rank=\"1\" name=\"PT\"\u003e\n                \u003clabel end=\"47\" start=\"0\" name=\"NP\"/\u003e\n                \u003clabel end=\"70\" start=\"59\" name=\"NP\"/\u003e\n            \u003c/layer\u003e\n            \u003clayer rank=\"1\" name=\"Sent\"/\u003e\n            \u003clayer rank=\"1\" name=\"Other\"/\u003e\n            \u003clayer rank=\"1\" name=\"Target\"\u003e\n                \u003clabel cBy=\"BoC\" end=\"57\" start=\"52\" name=\"Target\"/\u003e\n            \u003c/layer\u003e\n            \u003clayer rank=\"1\" name=\"Verb\"/\u003e\n        \u003c/annotationSet\u003e\n    \u003c/sentence\u003e\n\n```\n\nFor a detailed account of the Berkeley FrameNet XML format, check out the\n[XSD schema files](data/schema.zip).\n\nThe following tags should be identified by a unique number ID:\n- `\u003cannotationSet\u003e`\n- `\u003csentence\u003e`\n- `\u003clexUnit\u003e`\n- `\u003cframe\u003e`\n- `\u003ccorpus\u003e`\n- `\u003cdocument\u003e`\n- `\u003cFE\u003e`\n- `\u003cframeRelation\u003e`\n\n NoFrameNet extracts valence information (FE/PT/GF labels) from the `\u003cannotationSet\u003e` tags, and NOT from the `\u003cvalences\u003e` or `\u003cFERealization\u003e` tags.\n Make sure to have all FE/PT/GF layers under `\u003cannotationSet\u003e`\n specified when appropriate.\n\n[release-image]:https://img.shields.io/github/release/akb89/noframenet.svg?style=flat-square\n[release-url]:https://github.com/akb89/noframenet/releases/latest\n[travis-image]:https://img.shields.io/travis/akb89/noframenet.svg?style=flat-square\n[travis-url]:https://travis-ci.org/akb89/noframenet\n[framenet-image]:https://img.shields.io/badge/framenet-1.5%E2%87%A1-blue.svg?style=flat-square\n[framenet-url]:https://framenet.icsi.berkeley.edu/fndrupal\n[license-image]:http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square\n[license-url]:LICENSE.txt\n[david-url]: https://david-dm.org/akb89/noframenet\n[david-dep-image]: https://david-dm.org/akb89/noframenet.svg?style=flat-square\n[david-dev-dep-image]: https://img.shields.io/david/dev/akb89/noframenet.svg?style=flat-square\n[david-dev-url]: https://david-dm.org/akb89/noframenet?type=dev\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakb89%2Fnoframenet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakb89%2Fnoframenet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakb89%2Fnoframenet/lists"}