Vasily Alexeev commited on
Commit
fa53b40
·
1 Parent(s): efaeed7

add info about reproduction

Browse files
Files changed (2) hide show
  1. README.md +18 -0
  2. SHA256SUMS +1 -1
README.md CHANGED
@@ -53,6 +53,24 @@ Each UTF-8 CSV has exactly `id,raw_text,vw_text` columns and lexicographically o
53
 
54
  NOOW means occurrence order after preprocessing, not untouched or reversible prose. English preprocessing uses Python 3.11.15, NLTK 3.9.2 and NLTK-data commit `550b6625bcef1f2abff2ff770a5a0d272c9c6b2a`: WordPunctTokenizer, lowercase per original span, minimum token length 2, averaged_perceptron_tagger_eng, WordNet POS mapping J/V/N/R with noun fallback, English stopword removal and `lemma.isalpha()` filtering. Names are not masked.
55
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
56
  ## Loading and metadata
57
 
58
  The default configuration is `noow`; `bow` contains aggregated counts. Both expose the complete population as the Hugging Face split `corpus`. Labels and the stored fit/calibration/validation memberships are auxiliary files, joined by document ID. `data/labels.json` directly maps each string ID to a list of string labels; `data/splits.json` directly maps each split name to an ordered ID list.
 
53
 
54
  NOOW means occurrence order after preprocessing, not untouched or reversible prose. English preprocessing uses Python 3.11.15, NLTK 3.9.2 and NLTK-data commit `550b6625bcef1f2abff2ff770a5a0d272c9c6b2a`: WordPunctTokenizer, lowercase per original span, minimum token length 2, averaged_perceptron_tagger_eng, WordNet POS mapping J/V/N/R with noun fallback, English stopword removal and `lemma.isalpha()` filtering. Names are not masked.
55
 
56
+ ## Reproduce from source
57
+
58
+ The shared standalone code is in the [SciNews preprocessing folder](https://huggingface.co/datasets/TopicNet/SciNews/tree/main/preprocessing). Follow its [setup and code-download instructions](https://huggingface.co/datasets/TopicNet/SciNews/blob/main/preprocessing/README.md) to download only that folder at a full commit revision and create the locked Linux x86-64 environment with Python 3.11.15. Access follows the SciNews repository's permissions. No parent project checkout, BigARTM or TopicNet installation is needed.
59
+
60
+ From the directory containing the downloaded `preprocessing/` folder, choose writable source storage and fresh output and scratch paths:
61
+
62
+ ```bash
63
+ python preprocessing/prepare.py download --dataset bbc-news --sources-dir /path/to/sources
64
+ python preprocessing/prepare.py build --dataset bbc-news \
65
+ --sources-dir /path/to/sources \
66
+ --output-dir /path/to/rebuilt/BBC-News/data \
67
+ --scratch-dir /path/to/scratch/bbc-news
68
+ python preprocessing/prepare.py verify --dataset bbc-news \
69
+ --data-dir /path/to/rebuilt/BBC-News/data
70
+ ```
71
+
72
+ The download provides the pinned `bbc-news/bbc-fulltext.zip` and NLTK resources under the source directory. Build and verify run offline after setup. The output contains only `noow.csv`, `bow.csv`, `labels.json` and `splits.json`; verification compares them with the recorded SHA-256 values. Builds refuse to overwrite outputs. Preserve failed output and scratch files, and use fresh paths for a retry. The shared code's MIT license does not change the source-text rights below.
73
+
74
  ## Loading and metadata
75
 
76
  The default configuration is `noow`; `bow` contains aggregated counts. Both expose the complete population as the Hugging Face split `corpus`. Labels and the stored fit/calibration/validation memberships are auxiliary files, joined by document ID. `data/labels.json` directly maps each string ID to a list of string labels; `data/splits.json` directly maps each split name to an ordered ID list.
SHA256SUMS CHANGED
@@ -1,5 +1,5 @@
1
  947f03cf79a99d7f9061220c575021c918ae95f64ab75c4112917be804fb51cd .gitattributes
2
- da469495496a9cab4f590213fb9ea8c337c007a13a3d124b1bd8903a3febfe4e README.md
3
  eea76164b59389dd8e7267d30cd3680afa001143be2df8fc0631c8c991dd150b SOURCE_README.txt
4
  3d604bbbe7e2eb8907f162f87617ac38db413957067e558226bb132c2445100d data/bow.csv
5
  946d3a4ad97fcbb7952d8e3cc8f8a16f5ebdfdfce904939bc7c86ddbef90676d data/labels.json
 
1
  947f03cf79a99d7f9061220c575021c918ae95f64ab75c4112917be804fb51cd .gitattributes
2
+ 259515ccd37fb8c74ea090b51c684febcc934770fb6e0b1d22256d290cfbe835 README.md
3
  eea76164b59389dd8e7267d30cd3680afa001143be2df8fc0631c8c991dd150b SOURCE_README.txt
4
  3d604bbbe7e2eb8907f162f87617ac38db413957067e558226bb132c2445100d data/bow.csv
5
  946d3a4ad97fcbb7952d8e3cc8f8a16f5ebdfdfce904939bc7c86ddbef90676d data/labels.json