Update read me and documentation

[stochastic-sisyphus]

---

For more details, open the Copilot Workspace session.

Summary by Sourcery

Documentation:

• Expand the README.md to include detailed configuration options for data, preprocessing, embedding, clustering, visualization, summarization, logging, and checkpoints.

[ellipsis-dev]

Your free trial has expired. To keep using Ellipsis, sign up at https://app.ellipsis.dev or contact us.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR primarily focuses on enhancing documentation by adding comprehensive configuration documentation to the README.md file and updating the project planning document with configuration-related details. The changes provide detailed explanations of all configuration options available in the system, including data processing, model parameters, and pipeline settings.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Added detailed configuration documentation to explain all available options in the configuration file	Added documentation for data configuration options including input/output paths and dataset settings Added documentation for preprocessing configuration including text length limits and validation parameters Added documentation for embedding configuration including model settings and hardware options Added documentation for clustering configuration including algorithm parameters and output settings Added documentation for visualization, summarization, logging, and checkpoint configurations	README.md
Updated project planning document with configuration-related implementation details	Added configuration options section to the planning document Added detailed breakdown of configuration parameters and their descriptions	plan.md
Updated README structure and command-line examples	Added new section for running the pipeline with configuration file Reorganized section numbering to accommodate new content	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @stochastic-sisyphus - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider removing the duplicate configuration documentation from plan.md and keeping it only in README.md to avoid maintenance issues. The plan.md file should focus on development planning and strategy.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

suggestion: Please specify the units for min_length and max_length (characters, words, or tokens).

Suggested implementation:

  min_length: 100  # characters
  max_length: 1000  # characters

    min_text_length: 100  # characters
    max_text_length: 1000  # characters