Skip to content

Docs - Sphinx Indent Errors in Rest of API Reference #2069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Nov 28, 2023
Merged

Docs - Sphinx Indent Errors in Rest of API Reference #2069

merged 3 commits into from
Nov 28, 2023

Conversation

tonybove-apple
Copy link
Contributor

@tonybove-apple tonybove-apple commented Nov 22, 2023 •
edited
Loading

Click for Preview

This PR fixes the following indents and other warnings:

/Users/tonybove/opt/coremltools/coremltools/converters/mil/input_types.py:docstring of coremltools.converters.mil.input_types.EnumeratedShapes.__init__:9: WARNING: Definition list ends without a blank line; unexpected unindent.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/input_types.py:docstring of coremltools.converters.mil.input_types.EnumeratedShapes.__init__:11: WARNING: Definition list ends without a blank line; unexpected unindent.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/input_types.py:docstring of coremltools.converters.mil.input_types.EnumeratedShapes.__init__:16: WARNING: Definition list ends without a blank line; unexpected unindent.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS16/constexpr_ops.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS16.constexpr_ops.constexpr_affine_dequantize:9: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS16/constexpr_ops.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS16.constexpr_ops.constexpr_affine_dequantize:27: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS16/constexpr_ops.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS16.constexpr_ops.constexpr_affine_dequantize:26: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS16/constexpr_ops.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS16.constexpr_ops.constexpr_cast:4: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS16/constexpr_ops.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS16.constexpr_ops.constexpr_lut_to_dense:47: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS16/constexpr_ops.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS16.constexpr_ops.constexpr_sparse_to_dense:44: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS15/image_resizing.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS15.image_resizing.affine:52: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS15/image_resizing.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS15.image_resizing.resample:61: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS17/image_resizing.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS17.image_resizing.resize:40: WARNING: Bullet list ends without a blank line; unexpected unindent.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS17/reduction.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS17.reduction.reduce_argmax:5: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS17/reduction.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS17.reduction.reduce_argmin:5: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS17/scatter_gather.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS17.scatter_gather.gather:18: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS17/scatter_gather.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS17.scatter_gather.scatter:16: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS17/tensor_operation.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS17.tensor_operation.topk:5: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS17/tensor_operation.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS17.tensor_operation.topk:2: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/tonybove/opt/coremltools/coremltools/models/neural_network/builder.py:docstring of coremltools.models.neural_network.builder.NeuralNetworkBuilder.add_convolution:42: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/models/neural_network/builder.py:docstring of coremltools.models.neural_network.builder.NeuralNetworkBuilder.add_convolution:45: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/optimize/coreml/_post_training_quantization.py:docstring of coremltools.optimize.coreml._post_training_quantization.CoreMLWeightMetaData:52: ERROR: Unexpected indentation.
/Users/tonybove/opt/coremltools/coremltools/converters/mil/mil/ops/defs/iOS15/image_resizing.py:docstring of coremltools.converters.mil.mil.ops.defs.iOS15.image_resizing.affine:9: WARNING: Could not lex literal_block as "python". Highlighting skipped.
/Users/tonybove/opt/coremltools/coremltools/models/ml_program/compression_utils.py:docstring of coremltools.models.ml_program.compression_utils:1: WARNING: duplicate object description of coremltools.models.ml_program.compression_utils, other instance in source/coremltools.models.ml_program, use :noindex: for one of them
/Users/tonybove/opt/coremltools/coremltools/models/ml_program/compression_utils.py:docstring of coremltools.models.ml_program.compression_utils:1: WARNING: duplicate object description of coremltools.models.ml_program.compression_utils, other instance in source/coremltools.models.ml_program, use :noindex: for one of them
/Users/tonybove/opt/coremltools/coremltools/optimize/coreml/__init__.py:docstring of coremltools.optimize.coreml:1: WARNING: duplicate object description of coremltools.optimize.coreml, other instance in source/coremltools.optimize.coreml.config, use :noindex: for one of them

Click for Preview

@tonybove-apple tonybove-apple added the docs Contains documentation or clarification regarding docs (type) label Nov 22, 2023
@tonybove-apple tonybove-apple self-assigned this Nov 22, 2023
TobyRoseman
TobyRoseman requested changes Nov 27, 2023
View reviewed changes
coremltools/converters/mil/input_types.py Outdated
my_model,
inputs=[ct.TensorType(name="sample", shape=sample_shape)],
)
sample_shape = ct.EnumeratedShapes(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like you're using actual tabs characters here. We should never use tab characters in the coremltools repository. Instead of using a tab character, we should use four spaces.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed, took 2 commits because I didn't see one until I turned on viewing hidden characters in my editor.

TobyRoseman
TobyRoseman previously approved these changes Nov 27, 2023
View reviewed changes
@tonybove-apple tonybove-apple merged commit e111123 into apple:main Nov 28, 2023
@tonybove-apple tonybove-apple mentioned this pull request Dec 7, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TobyRoseman TobyRoseman TobyRoseman approved these changes

@aseemw aseemw Awaiting requested review from aseemw

@DawerG DawerG Awaiting requested review from DawerG

Assignees

@tonybove-apple tonybove-apple

Labels
docs Contains documentation or clarification regarding docs (type)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tonybove-apple @TobyRoseman