Skip to content

Releases: thiswillbeyourgithub/wdoc

Release 3.0.0

16 Apr 16:56
Compare
Choose a tag to compare

What's new

  • Version Update 3.0.0
  • Environment Variable Handling
    • Completely revamped the approach to handling environment variables.
  • Logging Improvements
    • Integrated loguru for more comprehensive logging.
    • Altered default log level based on debug status.

Enhancements

  • Documentation and Scripts
    • Updated README and other documentation to reflect recent changes.
    • Improved test scripts for more efficient testing.
  • Code Optimization
    • Streamlined environment variable checking for redundancy optimization.
    • Various small optimizations across multiple files led to better semantic batch handling.

Commits details since the last release

bumpver.toml
docs/source/conf.py
setup.py
wdoc/wdoc.py

tests/run_all_tests.sh

README.md

wdoc/utils/env.py
wdoc/wdoc.py

wdoc/main.py

wdoc/utils/env.py

wdoc/utils/env.py

wdoc/utils/logger.py

wdoc/main.py

wdoc/docs/help.md
wdoc/utils/init.py
wdoc/utils/batch_file_loader.py
wdoc/utils/embeddings.py
wdoc/utils/env.py
wdoc/utils/flags.py
wdoc/utils/llm.py
wdoc/utils/loaders.py
wdoc/utils/misc.py
wdoc/utils/tasks/query.py
wdoc/wdoc.py

wdoc/utils/env.py

wdoc/docs/help.md

wdoc/wdoc.py

wdoc/utils/logger.py
wdoc/utils/misc.py
wdoc/wdoc.py

wdoc/utils/logger.py

wdoc/main.py
wdoc/utils/batch_file_loader.py
wdoc/utils/embeddings.py
wdoc/utils/interact.py
wdoc/utils/llm.py
wdoc/utils/loaders.py
wdoc/utils/logger.py
wdoc/utils/misc.py
wdoc/utils/prompts.py
wdoc/utils/tasks/query.py
wdoc/utils/tasks/summarize.py
wdoc/wdoc.py

wdoc/utils/batch_file_loader.py

tests/test_wdoc.py

wdoc/utils/batch_file_loader.py
wdoc/utils/loaders.py
wdoc/utils/misc.py

wdoc/utils/tasks/summarize.py

tests/run_all_tests.sh

tests/test_wdoc.py

tests/test_wdoc.py

wdoc/utils/env.py

README.md

scripts/AnkiFiltered/AnkiFilteredDeckCreator.py

wdoc/utils/embeddings.py

wdoc/utils/env.py
wdoc/utils/misc.py

wdoc/utils/misc.py

wdoc/utils/batch_file_loader.py
wdoc/utils/import_tricks.py
wdoc/utils/llm.py
wdoc/utils/loaders.py
wdoc/utils/misc.py
wdoc/utils/tasks/query.py
wdoc/utils/typechecker.py
wdoc/wdoc.py

wdoc/utils/interact.py
wdoc/utils/logger.py

wdoc/utils/flags.py

wdoc/init.py

wdoc/utils/env.py
wdoc/utils/errors.py

README.md
wdoc/docs/help.md
wdoc/wdoc.py

wdoc/docs/help.md

README.md

README.md

Read more

Release 2.9.0

17 Mar 19:25
Compare
Choose a tag to compare

What's new

New Features

  • Shell Command Testing
    • Added shell command test for NYTimes parsing with content validation. [d3832f2]

Fixes

  • Intermediate Merging
    • Fixed error during batch merging, ensuring intermediate answers are handled properly when too large. [d06cbb3]
    • Improved logic for retry attempts during batch merging. [573e15f]
  • Parsing Reliability
    • Prevent return of intermediately parsed output on parsing failure. [78c9364]
    • Adapted handling to retry when encountering unparseable output or finish_reason=length. [763e9b4]
  • Backend and Output
    • Resolved backend errors and edge case issues breaking summary generation. [bf00ced, 89c01de]
    • Corrected handling of test outputs to avoid crashing in specific import modes. [ee416ec]
  • Testing Corrections
    • Corrected various test functions and ensured expected outcomes align with API changes. [bfcba71, 89c01de, 292ce90]

Documentation

  • General Updates
    • Enhanced walkthrough formatting for improved readability in documentation. [2ec7fad]
    • Provided context about the origins of wdoc in README. [31e6c5d]
  • Example and Help Docs
    • Updated examples documentation to remove confusing import_mode arguments. [cef5cdf]
    • Improved query and summary help documentation to reflect recent changes. [a289759, f1a6294]

Improvements

  • Configuration and Setup Adjustments
    • Simplified the post-install script to handle dependencies via uv if present. [7a55143, 4ed0a35]
  • Performance and Debugging Enhancements
    • Bumped max_tokens for intermediate answers to accommodate larger outputs during processing. [df059b6]
    • Stored original strings before parsing for effective debugging. [6ec3957]
    • Addressed deprecation warnings to keep up with latest standards. [15e4793]

Minor Changes

  • Code and Debug Tune-ups
    • Streamlined testing arguments and outputs for precise validation. [7e5e4ce, b7f1a1f, d79b4c5]
    • Fine-tuned post-install scripts and functional debug outputs for better clarity. [d620f87]
  • Enhanced wdoc Docs Via SVG Files (WIP)
    • Create SVG diagram and documentation for summary algorithm. [b5f49a9]
    • Added SVG visualization and improved design and intuitive flow representation for better understanding. [9489a8a, 703dde0]

Commits details since the last release

  • [d06cbb3] by @thiswillbeyourgithub, 34 minutes ago:
    fix: error when merging batch when intermediate answers got so large the model can't merge them anymore
    We just concatennate them using semantic order and that will be good
    enough, the alternative is too expensive

Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

wdoc/wdoc.py

wdoc/wdoc.py

wdoc/utils/misc.py

wdoc/wdoc.py

wdoc/utils/misc.py

wdoc/utils/misc.py

wdoc/wdoc.py

tests/test_wdoc.py

wdoc/docs/examples.md

tests/test_wdoc.py

wdoc/wdoc.py

tests/test_wdoc.py

README.md
scripts/AnkiFiltered/AnkiFilteredDeckCreator.py
scripts/TheFiche/TheFiche.py
tests/test_wdoc.py
wdoc/main.py
wdoc/docs/help.md
wdoc/wdoc.py

wdoc/wdoc.py

wdoc/utils/tasks/query.py

tests/test_wdoc.py

tests/test_wdoc.py

tests/test_wdoc.py

tests/test_wdoc.py

tests/test_wdoc.py

tests/test_wdoc.py

tests/test_wdoc.py

tests/test_wdoc.py

tests/test_wdoc.py

tests/test_wdoc.py

tests/test_wdoc.py

wdoc/wdoc.py

wdoc/wdoc.py

wdoc/docs/help.md
wdoc/wdoc.py

wdoc/wdoc.py

wdoc/wdoc.py

README.md

wdoc/docs/examples.md

README.md

README.md

Read more

Release 2.8.0

15 Mar 01:19
Compare
Choose a tag to compare

What's new

New Features

  • Add an environment variable to control invalid document evaluation behavior
  • Add WDOC_APPLY_ASYNCIO_PATCH env variable to manage asyncio patching
  • Specify name of LocalFileStore for better logging
  • Add a decorator for more useful debug logs

Improvements

Logging

  • Introduced better format for debug prints
  • Harmonized default environment value presentation in the documentation

Refactoring

  • Replaced hash-based source identifiers with a consistent format
  • Improved source identifier handling for single document cases

Bug Fixes

  • MAJOR Resolved error where sources were not properly referenced
  • MAJOR Addressed problems with cluster detection in text analysis
  • Applied patch before running tests to resolve buggy processes
  • Corrected issues with concurrency setting causing unexpected behavior
  • Fixed an obsolete script referencing an outdated environment variable

Documentation

  • Removed outdated mention of winston doc, replacing with current references

Dependency Management

  • To run tests, pytest-xdist must be installed
  • Bumped PersistDict to the latest version

Minor Changes

  • Various minor code and logic corrections throughout the codebase

Commits details since the last release

bumpver.toml
docs/source/conf.py
setup.py
wdoc/wdoc.py

tests/conftest.py

tests/conftest.py
tests/run_all_tests.sh

tests/conftest.py

tests/run_all_tests.sh

scripts/AnkiFiltered/AnkiFilteredDeckCreator.py

tests/run_all_tests.sh

tests/run_all_tests.sh

wdoc/utils/logger.py

wdoc/docs/help.md

wdoc/docs/help.md
wdoc/utils/env.py

wdoc/docs/help.md
wdoc/utils/env.py
wdoc/utils/tasks/query.py

wdoc/docs/help.md

wdoc/docs/help.md
wdoc/utils/env.py

wdoc/wdoc.py

wdoc/wdoc.py

wdoc/utils/tasks/query.py

wdoc/init.py
wdoc/docs/help.md
wdoc/utils/env.py

wdoc/init.py

wdoc/utils/tasks/query.py

wdoc/utils/embeddings.py
wdoc/utils/llm.py
wdoc/utils/tasks/query.py
wdoc/wdoc.py

wdoc/utils/misc.py
wdoc/utils/prompts.py
wdoc/utils/tasks/query.py
wdoc/wdoc.py

wdoc/utils/logger.py

wdoc/utils/logger.py

wdoc/utils/tasks/query.py

wdoc/utils/tasks/query.py

wdoc/utils/tasks/query.py

setup.py

wdoc/utils/misc.py
wdoc/utils/tasks/query.py
wdoc/utils/tasks/summarize.py

wdoc/wdoc.py

wdoc/wdoc.py

wdoc/wdoc.py

wdoc/utils/embeddings.py

wdoc/utils/embeddings.py

wdoc/init.py
wdoc/wdoc.py

setup.py

.gitignore

wdoc/utils/customs/fix_llm_caching.py
wdoc/utils/embeddings.py
wdoc/utils/retrievers.py

wdoc/utils/retrievers.py

setup.py

wdoc/utils/customs/compressed_embeddings_cacher.py

Read more

Release 2.7.1

11 Mar 21:52
Compare
Choose a tag to compare

What's new

Enhancements

  • Performance Improvements:
    • Updated PersistDict to the latest version for better performance.
    • Improved the efficiency of embeddings by attempting in-memory caching during load.
  • Model Handling:
    • Introduced adjustments to avoid reliance on external sources like litellm for model parameters and maximum tokens.
    • Implemented memoization for frequently called model name handlers to reduce computation times.
  • Testing Experience:
    • Integrated pytest-xdist to parallelize and speed up the test execution.
    • Optimized test performance by utilizing a session fixture scope.

Bug Fixes

  • Performance Fine-tuning:
    • Corrected versioning discrepancies for incrementals.
    • Addressed issues with multiple output answer handling.
  • Logging and Debugging:
    • Enhanced debug message levels to provide clearer output.
    • Resolved issues with redundant logger information.
  • Model Compatibility:
    • Amended model parameter defaults where strict support was unavailable.
    • Improved the hash method in ModelName for cache support integrity.
    • Fixed exit value inconsistency in create_embeddings.

Minor Changes

  • Code Refinement:
    • Eliminated unused arguments and flags for simplified code.
    • Enhanced error messages for better clarity during debugging.

Commits details since the last release

setup.py

bumpver.toml
docs/source/conf.py
setup.py
wdoc/wdoc.py

setup.py

wdoc/utils/misc.py

wdoc/utils/misc.py

wdoc/wdoc.py

wdoc/utils/embeddings.py
wdoc/utils/misc.py

wdoc/utils/misc.py

wdoc/wdoc.py

wdoc/docs/help.md
wdoc/wdoc.py

wdoc/utils/misc.py

wdoc/utils/misc.py

wdoc/utils/misc.py

wdoc/utils/misc.py

wdoc/wdoc.py

wdoc/utils/embeddings.py

tests/run_all_tests.sh

setup.py

tests/conftest.py

wdoc/utils/logger.py

wdoc/docs/help.md
wdoc/utils/flags.py
wdoc/utils/logger.py

wdoc/utils/logger.py

Release 2.7.0

07 Mar 22:02
Compare
Choose a tag to compare

What's new

🆕 New Features

  • Mentioned the inclusion of the official open webui tool across relevant documentation
  • Removed initial line "a deep breath" from summary output
  • Change default import type to native (safer but slower)

🐛 Fixes

  • Resolved undefined arguments and keyword arguments issue:
    • Bug fix conducted in the EnvVar.__getattr__ method.

📝 Documentation Improvements

  • Minor updates to improve readability and consistency.

Commits details since the last release

bumpver.toml
docs/source/conf.py
setup.py
wdoc/wdoc.py

README.md

README.md
wdoc/docs/examples.md

wdoc/utils/tasks/summarize.py

wdoc/utils/env.py

wdoc/docs/help.md
wdoc/utils/env.py

Release 2.6.10

06 Mar 18:09
Compare
Choose a tag to compare

What's new

Release Highlights

Fixes

  • Typographical Correction:
    • Resolved a typo issue causing crashes when using tags.
    • File Modified:
      • wdoc/utils/llm.py

Commits details since the last release

bumpver.toml
docs/source/conf.py
setup.py
wdoc/wdoc.py

wdoc/utils/llm.py

Release 2.6.9

06 Mar 17:37
Compare
Choose a tag to compare

What's new

Enhancements

  • Version Update
    • Updated from version 2.6.8 to 2.6.9 to reflect the latest changes and improvements.

Bug Fixes

  • Logger Improvements
    • Resolved an issue where previous loggers could be removed unintentionally. This fix ensures compatibility with other libraries, such as open-webui, that may configure their own loggers.

Commits details since the last release

bumpver.toml
docs/source/conf.py
setup.py
wdoc/wdoc.py

  • [adc6a44] by @thiswillbeyourgithub, 2 minutes ago:
    fix: do not remove previous logger
    they can be set by another lib, for example open-webui

Signed-off-by: thiswillbeyourgithub 26625900+thiswillbeyourgithub@users.noreply.github.com

wdoc/utils/logger.py

Release 2.6.8

06 Mar 16:56
Compare
Choose a tag to compare

What's new

  • Version Update

    • Bumped from version 2.6.7 to 2.6.8.
  • New Features

    • Implementation to prevent crashes if torchaudio cannot be imported.
  • Documentation

    • A new all_docs.rst file has been added for comprehensive documentation.
    • Mentioned availability of full documentation online in README.md.
    • Enhanced API documentation with infinite depth support.
    • Improved naming conventions for full documentation pages.
    • Added links directing users to all_docs and related pages.
  • Fixes

    • Corrected erroneous links in documentation files.
  • Minor Improvements

    • Added docstrings to facilitate code understanding.
    • Introduced type checking to additional functions in embeddings utils.
    • Adjusted usage to prefer vectorstore over faiss.

Commits details since the last release

bumpver.toml
docs/source/conf.py
setup.py
wdoc/wdoc.py

wdoc/utils/import_tricks.py

wdoc/utils/import_tricks.py
wdoc/utils/loaders.py

README.md

docs/source/all_docs.rst

docs/source/all_docs.rst

docs/source/all_docs.rst

docs/source/index.rst

docs/source/all_docs.rst

docs/source/api.rst

wdoc/utils/embeddings.py

wdoc/utils/embeddings.py

Release 2.6.7

04 Mar 11:19
Compare
Choose a tag to compare

What's new

  • fix litellm version needed a bump to have sonnet 3.7 prices
  • fix examples

Commits details since the last release

bumpver.toml
docs/source/conf.py
setup.py
wdoc/wdoc.py

setup.py

wdoc/docs/examples.md

Release 2.6.6

03 Mar 19:19
Compare
Choose a tag to compare

What's new

  • add tags and user env variable
  • experimental opt in auto refreshing env variables

Commits details since the last release

bumpver.toml
docs/source/conf.py
setup.py
wdoc/wdoc.py

tests/test_wdoc.py
wdoc/utils/env.py
wdoc/utils/misc.py

wdoc/utils/env.py

wdoc/utils/env.py

wdoc/docs/help.md

wdoc/docs/help.md
wdoc/utils/env.py
wdoc/utils/llm.py

wdoc/docs/help.md
wdoc/utils/env.py
wdoc/utils/llm.py