Difference between revisions of "Wikiq"

From CommunityData
(Add link to pattern matching design doc.)
(fix link)
Line 3: Line 3:
 
== Pattern matching matching ==
 
== Pattern matching matching ==
  
We are currently working on adding a general-purpose pattern matching feature to wikiq. [[Design Doc | Wikiq_Pattern_Matching]]  
+
We are currently working on adding a general-purpose pattern matching feature to wikiq. [[Wikiq Pattern Matching | Design Doc]]  
  
 
== ! New Wikiq in 2018 ==  
 
== ! New Wikiq in 2018 ==  

Revision as of 19:28, 16 October 2019

Wikiq is our tool for building tabular datasets from raw mediawiki edit data. Mediawiki outputs xml dump files, but these files are not so easy to work with, particularly because they contain the full text of every revision to every page. This makes it quite computationally expensive to process large wikis and leads to other technical problems. Wikiq efficiently processes mediawiki xml dumps to produce much smaller datasets that only contain variables that will be useful in our research. Nate is working this summer on improvements to wikiq. Let him know if you have any requests!.

Pattern matching matching

We are currently working on adding a general-purpose pattern matching feature to wikiq. Design Doc

! New Wikiq in 2018

If you want the new wikiq, with improved persistence measures, use wikiq_new . There will be some breaking changes to wikiq in summer 2018. Currently, the stable version of the new wikiq is called wikiq_new on hyak. At some point we will switch to calling the old version wikiq_old and the new version will be wikiq .

See Also: CommunityData:Dataset_And_Tools_Release_2018

Setting up Wikiq

Wikiq is a python3 program with dependencies. To run on Hyak, for now, you will need to install the dependencies using pip install --user mwxml pandas git+https://github.com/mediawiki-utilities/python-mwpersistence.git mediawiki-utilities pymysql


Command Line Arguments

Some important command line flags control the behavior wikiq and change which variables are output.

--url-encode : *Recommended* pass this in to url-encode text fields (page titles, editor names). This is used to safely handle text which might contain unicode characters that conflict with other parsing systems. You will probably want to url-decode these columns when you read them.

--persistence : Compute persistent word revisions, a useful measure of contribution quality, for each edit. This is somewhat costly, and slow, to compute. You can specify segment, sequence or legacy methods of calculating persistence. Segment is the default, and recommended way, but it is somewhat slower than sequence. Segment persistence is a faster, but marginally less accurate, version of the algorithm presented in this [paper https://arxiv.org/abs/1703.08244].

--collapse-user : Operate only on the final revision made by user a user within all sequences of consecutive edits made by a user. This can be useful for addressing issues with text persistence measures.

--help : Get help using Wikiq.

-n, --namespace-include Id of namespace to include. Can be specified more than once. For some wikis (e.g. Large Wikipedias) computing persistence for the project namespace can be extremely slow.

Codebook

The current version of wikiq provides one row for each edit (unless --collapse-user is passed, in which case each row corresponds to consecutive edits by the same editor): anon articleid collapsed_revs date_time deleted editor editor_id minor namespace revert reverteds revid sha1 text_chars title token_revs tokens_added tokens_removed tokens_window

The meaning of the variables is:

anon : Whether the editor is anonymous

articleid : Unique identifier for the page

date_time : Timestamp of the edit

deleted : Whether the edit was deleted

editor : The user name of the editor

editor_id : Unique identifier for the editor

minor : Whether the edit is minor

namespace : Id of the namespace. (see https://www.mediawiki.org/wiki/Manual:Namespace#Built-in_namespaces)

revert : The edit identity reverts one or more other edits.

reverteds : The ids of the edits that were reverted.

revid : Unique identifier of the revision.

sha1 : Hash of the article text of the revision

text_chars : Length of the article in characters following the revision


The following variables refer to persistent word revisions (PWR) and are only provided when wikiq is called with the --persistence argument:

token revs : The number of "token revisions" contributed by the edit. This is the key PWR variable.

tokens added : The number of tokens added by the edit.

tokens removed: The number of tokens removed by the edit.

tokens window : The maximum revisions examined in computing token revisions.


The following variables are output when wikiq is called with the --collapse-user argument:

collapsed_revs : The number of consecutive revisions the editor made that have been collapsed into the row.

Bugs

  • Not all anonymous edits get flagged as anon. Editor name being an IP Address seems to work (Not confirmed).