Uploaded image for project: 'Terrier Core'
  1. Terrier Core
  2. TR-557

Terrier 5.1 has an outdated documentation. Many things don't work especially for beginners.

    Details

      Description

      Hi
      The quick start guides available on Terrier homepage work only with older versions. I tested them with Terrier 4.2 and it works. If you check the documentation for both (4.2 and 5.1), you will find "nothing is changed".
       
      For both of the later versions (5.0 and 5.1), I first went through the tutorial and built the project using maven, then tried using terrier-core 5.1 as external jars in my java project. In either way, the org.terrier.realtime.memory.MemoryIndex class is missing. Similarly, org.terrier.structures.indexing.classical.BasicIndexer is also missing from where it should be.
      Kindly, update the tutorials as well as the documentation or provide the missing classes/code.
      Also: it would be nice if the homepage clearly mentions the stable versions.
      Kindest Regards

        Attachments

          Activity

          Hide
          craigm Craig Macdonald added a comment -

          Its not clear which of the quickstarts you refer to, as there are several.
          Both http://terrier.org/docs/v5.1/ and http://terrier.org/docs/current/ are for current version 5.1

          The integrated search with disk indices clearly states you need to import both terrier-core and terrier-batch-indexers:
          http://terrier.org/docs/v5.1/quickstart-integratedsearchdisk.html#importingterrier
          Similar for memory indices:
          http://terrier.org/docs/v5.1/quickstart-integratedsearch.html#importingterrier

          I'm happy to take pull requests on github to improve the current documentation.

          We don't have stable/unstable versions - we only maintain one branch of the software.

          Craig

          Show
          craigm Craig Macdonald added a comment - Its not clear which of the quickstarts you refer to, as there are several. Both http://terrier.org/docs/v5.1/ and http://terrier.org/docs/current/ are for current version 5.1 The integrated search with disk indices clearly states you need to import both terrier-core and terrier-batch-indexers: http://terrier.org/docs/v5.1/quickstart-integratedsearchdisk.html#importingterrier Similar for memory indices: http://terrier.org/docs/v5.1/quickstart-integratedsearch.html#importingterrier I'm happy to take pull requests on github to improve the current documentation. We don't have stable/unstable versions - we only maintain one branch of the software. Craig
          Hide
          Rocky Xanadul Irfan Ullah added a comment - - edited

          Respected Sir
          Thanks for the timely reply.
          I updated the pom.xml file and java source code ( pom.xml RetrievalExample.java ) by following the tutorial for Terrier 5.1 available at : http://terrier.org/docs/v5.1/quickstart-integratedsearchdisk.html. However, unlike Terrier 4.2 (which gives a detailed output), Terrier 5.1 gives less descriptive output and shows the document's file-name/path as null, as can be seen in the following output:

          WARNING: The file terrier.properties was not found at location \etc\terrier.properties
          Assuming the value of terrier.home from the corresponding system property. Please ensure that the property terrier.home is specified in the file terrier.properties, or as a system property in the command line.
          SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
          SLF4J: Defaulting to no-operation (NOP) logger implementation
          SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

          The top 4 documents were returned.
          Document Ranking
          Rank 0: 3 null 1.8767614632421292 3
          Rank 1: 0 null 1.5297190579669366 3
          Rank 2: 1 null 1.416545744789476 3
          Rank 3: 2 null 0.5589041095890411 1
          As can be seen, the problem is with the "docno" in the String docno = doc.getMetadata("docno"); but I am unable to understand it. For this I went through the documentation of the ScoredDoc available at http://terrier.org/docs/current/javadoc/org/terrier/querying/ScoredDoc.html#getMetadata-java.lang.String- but there only the list of methods are available with no description.

          Please help!

          Show
          Rocky Xanadul Irfan Ullah added a comment - - edited Respected Sir Thanks for the timely reply. I updated the pom.xml file and java source code ( pom.xml RetrievalExample.java ) by following the tutorial for Terrier 5.1 available at : http://terrier.org/docs/v5.1/quickstart-integratedsearchdisk.html . However, unlike Terrier 4.2 (which gives a detailed output), Terrier 5.1 gives less descriptive output and shows the document's file-name/path as null, as can be seen in the following output: WARNING: The file terrier.properties was not found at location \etc\terrier.properties Assuming the value of terrier.home from the corresponding system property. Please ensure that the property terrier.home is specified in the file terrier.properties, or as a system property in the command line. SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder". SLF4J: Defaulting to no-operation (NOP) logger implementation SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details. The top 4 documents were returned. Document Ranking Rank 0: 3 null 1.8767614632421292 3 Rank 1: 0 null 1.5297190579669366 3 Rank 2: 1 null 1.416545744789476 3 Rank 3: 2 null 0.5589041095890411 1 As can be seen, the problem is with the "docno" in the String docno = doc.getMetadata("docno"); but I am unable to understand it. For this I went through the documentation of the ScoredDoc available at http://terrier.org/docs/current/javadoc/org/terrier/querying/ScoredDoc.html#getMetadata-java.lang.String- but there only the list of methods are available with no description. Please help!
          Hide
          craigm Craig Macdonald added a comment -

          1. You are indexing using SimpleFileCollection - so, as specified in your RetrievalExample.java (see ApplicationSetup.setProperty("indexer.meta.forward.keys", "filename"), you are only recording the filename, not the docno.

          If you change
          String docno = doc.getMetadata("doc");
          to
          String docno = doc.getMetadata("filename");
          all will be well.

          2. Following the instructions at the SLF4J URL should help you get more detailed logging - see https://www.slf4j.org/codes.html#StaticLoggerBinder

          Craig

          Show
          craigm Craig Macdonald added a comment - 1. You are indexing using SimpleFileCollection - so, as specified in your RetrievalExample.java (see ApplicationSetup.setProperty("indexer.meta.forward.keys", "filename") , you are only recording the filename, not the docno. If you change String docno = doc.getMetadata("doc"); to String docno = doc.getMetadata("filename"); all will be well. 2. Following the instructions at the SLF4J URL should help you get more detailed logging - see https://www.slf4j.org/codes.html#StaticLoggerBinder Craig
          Hide
          Rocky Xanadul Irfan Ullah added a comment -

          Respected Sir

          I changed it and it works now. Is there any detailed documentation, e.g., how one will know "docno" should be replaced with "filename", I mean how terrier understands the meaning of "filename."
          Also, I humbly suggest that the source code on the mentioned tutorial page should be corrected and updated now.

          Irfan

          Show
          Rocky Xanadul Irfan Ullah added a comment - Respected Sir I changed it and it works now. Is there any detailed documentation, e.g., how one will know "docno" should be replaced with "filename", I mean how terrier understands the meaning of "filename." Also, I humbly suggest that the source code on the mentioned tutorial page should be corrected and updated now. Irfan

            People

            • Assignee:
              craigm Craig Macdonald
              Reporter:
              Rocky Xanadul Irfan Ullah
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated: