mirror of
https://github.com/facebookresearch/faiss.git
synced 2025-06-03 21:54:02 +08:00
Summary: This adds docstrings for most of the replaced methods. This will make the doc visible in notebooks. Reviewed By: wickedfoo Differential Revision: D26856664 fbshipit-source-id: da05cf8ac8380ee06a94a380d2547991b0c0a3be
20 lines
507 B
Python
20 lines
507 B
Python
# Copyright (c) Facebook, Inc. and its affiliates.
|
|
#
|
|
# This source code is licensed under the MIT license found in the
|
|
# LICENSE file in the root directory of this source tree.
|
|
|
|
import unittest
|
|
|
|
import faiss
|
|
|
|
|
|
class TestDocumentation(unittest.TestCase):
|
|
|
|
def test_io_error(self):
|
|
index = faiss.IndexFlatL2(32)
|
|
|
|
self.assertTrue("Adds vectors to the index" in index.add.__doc__)
|
|
|
|
# At some point we will check here if SWIG imported the C++ doxygen comments
|
|
# for the classes as docstrings
|